Module sycamore::web

source ·
Expand description

Web support for Sycamore.

Modules§

  • events
    Re-export of HTML event types from web-sys for convenience.
  • html
    HTML and SVG tag definitions.
  • hydrate
    Utilities for client-side hydration in the browser.
  • js_sys
    Bindings to JavaScript’s standard, built-in objects, including their methods and properties.
  • portal
    Portal API.

Structs§

Traits§

  • Html
    Trait that is implemented by all GenericNode backends that render to HTML.

Functions§

  • NoHydrate
    Render the children of this component in a scope that will not be hydrated.
  • NoSsr
    Only render the children of this component in the browser. The children are wrapped inside a <div> element to prevent conflicts with surrounding elements.
  • hydrate
    Render a View under a parent node by reusing existing nodes (client side hydration). Alias for hydrate_to with parent being the <body> tag.
  • hydrate_in_scope
    Render a 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).
  • hydrate_to
    Render a View under a parent node by reusing existing nodes (client side hydration). For rendering under the <body> tag, use hydrate instead.
  • 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. 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).
  • 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_await_suspense
    Render a View into a static String. Useful for rendering to a string on the server side.