Struct leptos_dom::NodeRef

pub struct NodeRef(_);

Contains a shared reference to a DOM node creating while using the view macro to create your UI.

#[component]
pub fn MyComponent(cx: Scope) -> Element {
  let input_ref = NodeRef::new(cx);

  let on_click = move |_| {
    let node = input_ref
      .get()
      .expect("input_ref should be loaded by now")
      .unchecked_into::<web_sys::HtmlInputElement>();
    log!("value is {:?}", node.value())
  };

  view! {
    cx,
    <div>
    // `node_ref` loads the input
    <input _ref=input_ref type="text"/>
    // the button consumes it
    <button on:click=on_click>"Click me"</button>
    </div>
  }
}

Implementations

impl NodeRef

pub fn new(cx: Scope) -> Self

Creates an empty reference.

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

Gets the element that is currently stored in the reference.

This tracks reactively, so that node references can be used in effects. Initially, the value will be None, but once it is loaded the effect will rerun and its value will be Some(Element).

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 Fn() for NodeRef

extern "rust-call" fn call(&self, _args: ()) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl FnMut() for NodeRef

extern "rust-call" fn call_mut(&mut self, _args: ()) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl FnOnce() for NodeRef

type Output = Option<Element>

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, _args: ()) -> Self::Output

🔬This is a nightly-only experimental API. (fn_traits)

Performs the call operation.

impl PartialEq<NodeRef> for NodeRef

fn eq(&self, other: &NodeRef) -> 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 Copy for NodeRef

impl StructuralPartialEq for NodeRef