Crate sycamore_web

Expand description

§`sycamore-web`

Web rendering backend for sycamore. This is already re-exported in the main sycamore crate, so you should rarely need to use this crate directly.

§Feature flags

hydrate - Enables hydration support in DOM node. By default, hydration is disabled to reduce binary size.
suspense - Enables suspense and resources support.
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 resulting .wasm binary, you might want to disable this.

§Server Side Rendering

This crate uses target detection to determine whether to use DOM or SSR as the rendering backend. If the target arch is wasm32, DOM rendering will be used. Otherwise, SSR will be used. Sometimes, this isn’t desirable (e.g., if using server side wasm). To override this behavior, you can set --cfg sycamore_force_ssr in your RUSTFLAGS environment variable when compiling to force SSR mode even on wasm32.

Re-exports§

pub use js_sys;
pub use wasm_bindgen;

Modules§

bind
Definition for bind-able attributes/properties.
events
Definition for all the events that can be listened to.
tags
Definition of all the HTML and SVG elements.

Macros§

cfg_not_ssr_item
macro_rules! equivalent of cfg_not_ssr. This is to get around the limitation of not being able to put proc-macros on mod items.
cfg_ssr_item
macro_rules! equivalent of cfg_ssr. This is to get around the limitation of not being able to put proc-macros on mod items.
console_dbg
Debug the value of a variable to the JavaScript console if on wasm32. Otherwise logs it to stdout.
console_error
Prints an error message to the JavaScript console if on wasm32. Otherwise logs it to stderr.
console_log
Log a message to the JavaScript console if on wasm32. Otherwise logs it to stdout.
console_warn
Log a warning to the JavaScript console if on wasm32. Otherwise logs it to stderr.
is_not_ssr
A macro that expands to whether we are in DOM mode or not.
is_ssr
A macro that expands to whether we are in SSR mode or not.

Structs§

Attributes
A special prop type that can be used to spread attributes onto an element.
CustomElement
A struct representing a custom element. This can be created by calling custom_element.
HydrationKey
IndexedProps
Props for Keyed.
KeyedProps
Props for Keyed.
NoHydrate_Props
Props for NoHydrate.
NoSsr_Props
Props for NoSsr.
NodeRef
A reference to a web_sys::Node. This allows imperative access to the node.
Portal_Props
Props for Portal.
ShowProps
Props for Show.
View
Represents a view tree.

Enums§

SsrMode
The mode in which SSR is being run.
SsrNode

Traits§

AsHtmlNode
A trait for unwrapping a type into an HtmlNode.
AttributeValue
A trait that represents an attribute that can be set. This is not “attribute” in the HTML spec sense. It can also represent JS properties (and possibly more …) that can be set on an HTML element.
GlobalAttributes
Attributes that are available on all elements.
GlobalProps
Props that are available on all elements.
HtmlGlobalAttributes
A trait that is implemented for all elements and which provides all the global HTML attributes.
SetAttribute
Implemented for all types that can accept attributes (AttributeValue).
SvgGlobalAttributes
A trait that is implemented for all SVG elements and which provides all the global SVG attributes.
ViewHtmlNode
A trait that should be implemented for anything that represents an HTML node.
ViewNode
A trait that should be implemented for anything that represents a node in the view tree (UI tree).

Functions§

HydrationScript
Component that creates a script element for bootstrapping hydration. Should be rendered into the <head> of the document.
Indexed
Non keyed iteration (or keyed by index).
Keyed
Keyed iteration.
NoHydrate
Components that do not need, or should not be hydrated on the client side.
NoSsr
Component that is only renders its children on the client side.
Portal
A portal into a different part of the DOM. Only renders in client side rendering (CSR) mode. Does nothing in SSR mode.
Show
An utility component that only renders its children when a condition is satisfied.
create_client_effect
Create a new effect, but only if we are not in SSR mode.
create_node_ref
Create a new NodeRef.
custom_element
Create a new custom element with tag.
document
Utility function for accessing the global web_sys::Document object.
generate_hydration_script
Generate a script element for bootstrapping hydration.
is_hydrating
Returns whether we are currently hydrating or not.
on_mount
Queue up a callback to be executed when the component is mounted.
queue_microtask
Alias for queueMicrotask.
render
Render a View into the DOM. Alias for render_to with parent being the <body> tag.
render_in_scope
Render a View under a parent node, in a way that can be cleaned up.
render_to
Render a View under a parent node. For rendering under the <body> tag, use render instead.
render_to_string
Render a View into a static String. Useful for rendering to a string on the server side.
render_to_string_in_scope
Render a View into a static String in the current reactive scope.
use_stable_counter
Get the next counter value. This is stable across client and server side.
window
Utility function for accessing the global web_sys::Window object.

Type Aliases§

BoolAttribute
Type alias respresenting a possibly dynamic boolean value.
Children
A type alias for Children automatically selecting the correct node type.
HtmlNode
A type alias for the rendering backend.
StringAttribute
Type alias representing a possibly dynamic string value.

Attribute Macros§

wasm_bindgen
Re-export of js-sys and wasm-bindgen for convenience.

Crate sycamore_webCopy item path

§sycamore-web