Struct sycamore::prelude::HydrateNode

pub struct HydrateNode { /* private fields */ }

Rendering backend for the DOM with hydration support.

This API requires the following crate features to be activated: hydrate, dom

Implementations

impl HydrateNode

pub fn inner_element(&self) -> Node

Get the underlying web_sys::Node.

pub fn unchecked_into<T>(self) -> Twhere
    T: JsCast,

Cast the underlying web_sys::Node using JsCast.

pub fn from_web_sys(node: Node) -> HydrateNode

Create a new DomNode from a raw web_sys::Node.

Trait Implementations

impl AsRef<JsValue> for HydrateNode

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HydrateNode

fn clone(&self) -> HydrateNode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HydrateNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Prints outerHtml of Node.

impl From<HydrateNode> for JsValue

fn from(node: HydrateNode) -> JsValue

Converts to this type from the input type.

impl GenericNode for HydrateNode

fn element<T>() -> HydrateNodewhere
    T: SycamoreElement,

When hydrating, instead of creating a new node, this will attempt to hydrate an existing node.

fn element_from_tag(tag: &str) -> HydrateNode

When hydrating, instead of creating a new node, this will attempt to hydrate an existing node.

fn text_node(text: &str) -> HydrateNode

When hydrating, instead of creating a new node, this will attempt to hydrate an existing node.

type EventType = Event

The type of the event that is passed to the event handler.

type PropertyType = JsValue

The type for set_property.

const USE_HYDRATION_CONTEXT: bool = true

Whether this rendering backend needs the hydration registry.

const CLIENT_SIDE_HYDRATION: bool = true

Whether this rendering backend hydrates nodes on the client side.

fn marker() -> HydrateNode

Create a marker (dummy) node. For DomNode, this is implemented by creating an empty comment node. This is used, for example, in Keyed and Indexed for scenarios where you want to push a new item to the end of the list. If the list is empty, a dummy node is needed to store the position of the component.

fn marker_with_text(text: &str) -> HydrateNode

Create a marker (dummy) node with text content. For empty marker, prefer GenericNode::marker instead.

fn set_attribute(&self, name: &str, value: &str)

Sets an attribute on a node.

fn remove_attribute(&self, name: &str)

Removes an attribute on a node.

fn set_class_name(&self, value: &str)

Sets the class attribute on a node. This should have the same outcome as calling set_attribute("class", value). For DomNode, this sets the className property directly which is about 2x faster (on Chrome).

fn add_class(&self, class: &str)

Add a class to the element. If multiple classes are specified, delimited by spaces, all the classes should be added. Any classes that are already present should not be added a second time.

fn remove_class(&self, class: &str)

Remove a class from the element.

fn set_property(&self, name: &str, value: &JsValue)

Sets a property on a node.

fn remove_property(&self, name: &str)

Removes a property on a node.

fn append_child(&self, child: &HydrateNode)

Appends a child to the node’s children.

fn first_child(&self) -> Option<HydrateNode>

Get the first child of the node.

fn insert_child_before(
    &self,
    new_node: &HydrateNode,
    reference_node: Option<&HydrateNode>
)

Insert a new child node to this node’s children. If reference_node is Some, the child will be inserted before the reference node. Else if None, the child will be inserted at the end.

fn remove_child(&self, child: &HydrateNode)

Remove a child node from this node’s children.

fn replace_child(&self, old: &HydrateNode, new: &HydrateNode)

Replace a child node from this node’s children with a new child node.

fn insert_sibling_before(&self, child: &HydrateNode)

Insert a new node before this node.

fn parent_node(&self) -> Option<HydrateNode>

Returns the parent node, or None if detached.

fn next_sibling(&self) -> Option<HydrateNode>

Returns the next sibling, or None if this node is the last sibling.

fn remove_self(&self)

Remove this node from the tree.

fn event<'a, F>(&self, cx: BoundedScope<'a, 'a>, name: &str, handler: F)where
    F: 'a + FnMut(<HydrateNode as GenericNode>::EventType),

Add a event handler to the event name. The event should be removed once the scope is disposed, as to prevent accessing scope variables after the scope is disposed.

fn update_inner_text(&self, text: &str)

Update inner text of the node. If the node has elements, all the elements are replaced with a new text node.

fn dangerously_set_inner_html(&self, html: &str)

Updates the inner html of the node. The html will not be parsed in non-browser environments. This means that accessing methods such as first_child will return None.

fn clone_node(&self) -> HydrateNode

Create a deep clone of the node.

fn text_node_int(int: i32) -> Self

Create a new text node from an integer.

impl Hash for HydrateNode

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Html for HydrateNode

const IS_BROWSER: bool = true

A boolean indicating whether this node is rendered in a browser context.

fn to_web_sys(&self) -> Node

Convert this node into a raw web_sys::Node.

impl PartialEq<HydrateNode> for HydrateNode

fn eq(&self, other: &HydrateNode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HydrateNode