Struct NodeRef

pub struct NodeRef(/* private fields */);

Wrapped Node reference for later use in Component lifecycle methods.

Example

Focus an <input> element on mount.

use web_sys::HtmlInputElement;

pub struct Input {
    node_ref: NodeRef,
}

impl Component for Input {
    type Message = ();
    type Properties = ();

    fn create(_ctx: &Context<Self>) -> Self {
        Input {
            node_ref: NodeRef::default(),
        }
    }

    fn rendered(&mut self, _ctx: &Context<Self>, first_render: bool) {
        if first_render {
            if let Some(input) = self.node_ref.cast::<HtmlInputElement>() {
                input.focus();
            }
        }
    }

    fn view(&self, _ctx: &Context<Self>) -> Html {
        html! {
            <input ref={self.node_ref.clone()} type="text" />
        }
    }
}

Relevant examples

• Node Refs

Implementations

impl NodeRef

pub fn get(&self) -> Option<Node>

Get the wrapped Node reference if it exists

pub fn cast<INTO: AsRef<Node> + From<JsValue>>(&self) -> Option<INTO>

Try converting the node reference into another form

Trait Implementations

impl Clone for NodeRef

fn clone(&self) -> NodeRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeRef

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

Formats the value using the given formatter.

impl Default for NodeRef

fn default() -> NodeRef

Returns the “default value” for a type.

impl ImplicitClone for NodeRef

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as

impl PartialEq for NodeRef

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

Tests for self and other values to be equal, and is used by ==.

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

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