Module sycamore::prelude

The sycamore prelude.

In most cases, it is idiomatic to use a glob import (aka wildcard import) at the beginning of your Rust source file.

use sycamore::prelude::*;

Re-exports

• pub use crate::flow::*;
• pub use crate::reactive::*;

Macros

• view
  A macro for ergonomically creating complex UI complex layouts.

Structs

• Attributes
  A special property type to allow the component to accept passthrough attributes. This can be useful if your component wraps an HTML element, i.e. accessible component libraries.
• Children
  A special property type to allow the component to accept children.
• DomNode
  Rendering backend for the DOM.
• HydrateNode
  Rendering backend for the DOM with hydration support.
• NodeRef
  A reference to a GenericNode. This allows imperatively accessing the node.
• SsrNode
  Rendering backend for Server Side Rendering, aka. SSR.
• View
  Represents an UI view. Usually constructed using the view! macro or using the builder API.

Enums

• AttributeValue
  The value of a passthrough attribute. The default for unknown attributes is AttributeValue::Str or AttributeValue::DynamicStr

Traits

• GenericNode
  Abstraction over a rendering backend.
• Html
  Trait that is implemented by all GenericNode backends that render to HTML.

Functions

• create_node_ref
  Create a new NodeRef on the current [Scope].
• create_unique_id
  Create a unique ID that’s stable between SSR and hydration.
• on_mount
  Queue up a callback to be executed when the component is mounted.

Attribute Macros

• component
  A macro for creating components from functions.

Derive Macros

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