Expand description
Sycamore API Documentation
Sycamore is a VDOM-less web library with fine-grained reactivity.
This is the API docs for sycamore. If you are looking for the usage docs, checkout the Sycamore Book.
Feature Flags
-
hydrate
- Enables client-side hydration support. -
suspense
- Enables wrappers aroundwasm-bindgen-futures
to make it easier to extend a reactive scope into anasync
function. -
ssr
- Enables rendering templates to static strings (useful for Server Side Rendering / Pre-rendering). -
serde
- Enables serializing and deserializingSignal
s and other wrapper types usingserde
. -
wasm-bindgen-interning
(default) - Enables interning forwasm-bindgen
strings. This improves performance at a slight cost in binary size. If you want to minimize the size of the result.wasm
binary, you might want to disable this. -
web
(default) - Enables the web backend for Sycamore. This feature is enabled by most of the other features so you should rarely need to enable it manually.
Re-exports
pub use web::render_to_string_await_suspense;
Modules
sycamore-reactive
crate.async
/await
support.Macros
Functions
View
under a parent
node by reusing existing nodes (client side
hydration). Alias for hydrate_to
with parent
being the <body>
tag.View
under a parent
node, in a way that can be cleaned up.
This function is intended to be used for injecting an ephemeral sycamore view into a
non-sycamore app (for example, a file upload modal where you want to cancel the upload if the
modal is closed).View
under a parent
node by reusing existing nodes (client side
hydration). For rendering under the <body>
tag, use hydrate_to
instead.View
under a parent
node, in a way that can be cleaned up.
This function is intended to be used for injecting an ephemeral sycamore view into a
non-sycamore app (for example, a file upload modal where you want to cancel the upload if the
modal is closed).