Crate sycamore

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

• dom (default) - Enables rendering templates to DOM nodes. Only useful on wasm32-unknown-unknown target.
• experimental-builder-agnostic - Enables the agnostic backend builder API.
• experimental-builder-html - Enables the HTML specific backend builder API. Also enables experimental-builder-agnostic.
• experimental-hydrate - Enables client-side hydration support.
• futures - Enables wrappers around wasm-bindgen-futures to make it easier to extend a reactive scope into an async function.
• ssr - Enables rendering templates to static strings (useful for Server Side Rendering / Pre-rendering).
• serde - Enables serializing and deserializing Signals and other wrapper types using serde.
• wasm-bindgen-interning (default) - Enables interning for wasm-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.

Re-exports

pub use sycamore_reactive as reactive;

pub use crate::generic_node::hydrate;

pub use crate::generic_node::hydrate_to;

pub use crate::generic_node::HydrateNode;

pub use crate::generic_node::render;

pub use crate::generic_node::render_get_scope;

pub use crate::generic_node::render_to;

pub use crate::generic_node::DomNode;

pub use crate::generic_node::render_to_string;

pub use crate::generic_node::SsrNode;

Modules

builder

The builder pattern API for creating UI elements.

component

The definition of the Component trait.

context

Context API.

easing

Easing functions.

flow

Iteration utility components for view!.

futures

Utilities for working with Futures and async/await code.

generic_node

Abstraction over a rendering backend.

motion

Utilities for smooth transitions and animations.

noderef

References to nodes in templates.

portal

Portal API.

prelude

The sycamore prelude.

utils

Internal utilities for Sycamore.

view

Result of the view! macro.

Macros

node

view

A macro for ergonomically creating complex UI structures.

Attribute Macros

component

A macro for creating components from functions.