Crate sycamore

Source
Expand description

§Sycamore API Documentation

Sycamore is a reactive library for creating web apps in Rust and WebAssembly.

This is the API docs for sycamore. If you are looking for the usage docs, checkout the Sycamore Book.

§Feature Flags

  • hydrate - Enables hydration support in DOM nodes. By default, hydration is disabled to reduce binary size.

  • serde - Enables serializing and deserializing Signals and other wrapper types using serde.

  • suspense - Enalbes suspense and resources. Also enables wrappers around wasm-bindgen-futures to make it easier to extend a reactive scope into an async function.

  • nightly - Enables nightly-only features. This makes it slightly more ergonomic to use signals.

  • 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.

  • 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.

Modules§

  • Easing functions.
  • Utilities for working with async.
  • Utilities for smooth transitions and animations.
  • The Sycamore prelude.
  • Reactive primitives for Sycamore.
  • Web support for Sycamore.

Macros§

  • A macro for ergonomically creating complex UI complex layouts.

Functions§

Attribute Macros§

  • A macro for feature gating code that should only be run on the web.
  • A macro for feature gating code that should only be run on the server.
  • A macro for creating components from functions.

Derive Macros§

  • The derive macro for Props. The macro creates a builder-like API used in the view! macro.