Enum virtual_dom_rs::VirtualNode

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

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.

Methods

impl VirtualNode

pub fn filter_label<F>(&'a self, filter: F) -> Vec<&'a VirtualNode> where
    F: Fn(&str) -> bool, 

Get a vector of all of the VirtualNode children / grandchildren / etc of your virtual_node that have a label that matches your filter.

Examples

let component = html! {<div>
 <span label="hello",> {"Hi!"} </span>
 <em label="world",> {"There!!"} </em>
 <em label="hello",></em>
</div> };

let hello_nodes = component.filter_label(|label| {
    label.contains("hello")
});

assert_eq!(hello_nodes.len(), 2);
}

pub fn filter_label_equals(&'a self, label: &str) -> Vec<&'a VirtualNode>

Get a vector of all of the descendants of this VirtualNode that have the provided filter.

Examples

let component = html! {<div>
 <span label="hello",> {"Hi!"} </span>
 <em label="world",> {"There!!"} </em>
 <em label="hello",></em>
</div> };

let hello_nodes = component.filter_label_equals("hello");

assert_eq!(hello_nodes.len(), 2);
}

impl VirtualNode

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

Create a new virtual element node with a given tag.

These get patched into the DOM using document.createElement

use virtual_dom_rs::VirtualNode;

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

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

Create a new virtual text node with the given text.

These get patched into the DOM using document.createTextNode

use virtual_dom_rs::VirtualNode;

let div = VirtualNode::text("div");

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

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

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

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

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

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

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

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

pub fn create_dom_node(&self) -> CreatedNode<Node>

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

Trait Implementations

impl Display for VirtualNode

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

Formats the value using the given formatter.

impl IntoIterator for VirtualNode

type Item = VirtualNode

The type of the elements being iterated over.

type IntoIter = IntoIter<VirtualNode>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <VirtualNode as IntoIterator>::IntoIter

Creates an iterator from a value.

impl From<VElement> for VirtualNode

fn from(other: VElement) -> VirtualNode

Performs the conversion.

impl From<String> for VirtualNode

fn from(other: String) -> VirtualNode

Performs the conversion.

impl<'_> From<&'_ str> for VirtualNode

fn from(other: &str) -> VirtualNode

Performs the conversion.

impl From<VirtualNode> for IterableNodes

fn from(other: VirtualNode) -> IterableNodes

Performs the conversion.

impl From<VText> for VirtualNode

fn from(other: VText) -> VirtualNode

Performs the conversion.

impl Into<IntoIter<VirtualNode>> for VirtualNode

Important traits for IntoIter<T>

impl<T> Iterator for IntoIter<T> type Item = T;

fn into(self) -> IntoIter<VirtualNode>

Performs the conversion.

impl PartialEq<VirtualNode> for VirtualNode

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

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

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

This method tests for !=.

impl Debug for VirtualNode

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

Formats the value using the given formatter.