Enum virtual_node::VirtualNode

source · [−]

pub enum VirtualNode {
    Element(VElement),
    Text(VText),
}

Expand description

When building your views you’ll typically use the html! macro to generate VirtualNode’s.

html! { <div> <span></span> </div> } really generates a VirtualNode with one child (span).

Later, on the client side, you’ll use the diff and patch modules to update the real DOM with your latest tree of virtual nodes (virtual dom).

Or on the server side you’ll just call .to_string() on your root virtual node in order to recursively render the node and all of its children.

TODO: Make all of these fields private and create accessor methods TODO: Create a builder to create instances of VirtualNode::Element with attrs and children without having to explicitly create a VElement

Variants

`Element(VElement)`

An element node (node type ELEMENT_NODE).

`Text(VText)`

A text node (node type TEXT_NODE).

Note: This wraps a VText instead of a plain String in order to enable custom methods like create_text_node() on the wrapped type.

Implementations

source

impl VirtualNode

source

pub fn children_recursive<'a>(&'a self) -> Vec<&'a VirtualNode>

Get a vector of all of the VirtualNode children / grandchildren / etc of your virtual_node.

Children are visited recursively depth first.

Examples

let component = html! {
 <div>
   <span> {"Hi!"} </span>
   <em> {"There!!"} </em>
   <div> {"My Friend"} </div>
 </div>
};

let children = component.children_recursive();

assert_eq!(children[2].tag(), "em");

source

impl VirtualNode

source

pub fn element<S>(tag: S) -> Self where
S: Into<String>,

Create a new virtual element node with a given tag.

These get patched into the DOM using document.createElement

let _div = VirtualNode::element("div");

source

pub fn text<S>(text: S) -> Self where
S: Into<String>,

Create a new virtual text node with the given text.

These get patched into the DOM using document.createTextNode

let _text = VirtualNode::text("My text node");

source

pub fn as_velement_ref(&self) -> Option<&VElement>

Return a VElement reference, if this is an Element variant.

source

pub fn as_velement_mut(&mut self) -> Option<&mut VElement>

Return a mutable VElement reference, if this is an Element variant.

source

pub fn as_vtext_ref(&self) -> Option<&VText>

Return a VText reference, if this is an Text variant.

source

pub fn as_vtext_mut(&mut self) -> Option<&mut VText>

Return a mutable VText reference, if this is an Text variant.

source

pub fn create_dom_node(
    &self,
    node_idx: u32,
    events: &mut EventsByNodeIdx
) -> Node

Create and return a CreatedNode instance (containing a DOM Node together with potentially related closures) for this virtual node.

source

pub fn insert_space_before_text(&mut self)

Used by html-macro to insert space before text that is inside of a block that came after an open tag.

html! {

{world}

}

So that we end up with

world

when we’re finished parsing.

source

pub fn insert_space_after_text(&mut self)

Used by html-macro to insert space after braced text if we know that the next block is another block or a closing tag.

html! {

{Hello} {world}

} ->

Hello world

html! {

{Hello}

} ->

Hello

So that we end up with

Hello world

when we’re finished parsing.

Trait Implementations

source

impl Debug for VirtualNode

source

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

Formats the value using the given formatter. Read more

source

impl Display for VirtualNode

source

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

Formats the value using the given formatter. Read more

source