Struct mogwai::view::builder::ViewBuilder

pub struct ViewBuilder<T: IsDomNode> {
    pub element: Option<String>,
    pub ns: Option<String>,
    pub text: Option<Effect<String>>,
    pub attribs: Vec<AttributeCmd>,
    pub styles: Vec<StyleCmd>,
    pub events: Vec<EventTargetCmd>,
    pub posts: Vec<Transmitter<T>>,
    pub patches: Vec<Receiver<Patch<View<Node>>>>,
    pub children: Vec<ViewBuilder<Node>>,
}

An un-built mogwai view. A ViewBuilder is the most generic view representation in the mogwai library. It is the zyghost of a view - the blueprints - everything needed to create, hydrate or serialized a view.

Fields

element: Option<String>

Tag name of the DOM element.

ns: Option<String>

Namespace of the DOM element.

text: Option<Effect<String>>

This element's text if it is a text node.

attribs: Vec<AttributeCmd>

This view's attribute declarations.

styles: Vec<StyleCmd>

This view's style declarations.

events: Vec<EventTargetCmd>

This view's declared events.

posts: Vec<Transmitter<T>>

This view's post-build transmitters.

patches: Vec<Receiver<Patch<View<Node>>>>

This view's child patch receivers.

children: Vec<ViewBuilder<Node>>

This view's children.

Implementations

impl<T: IsDomNode + AsRef<Node>> ViewBuilder<T>

pub fn to_node(self) -> ViewBuilder<Node>

Upcast the builder's inner DomNode to web_sys::Node.

Trait Implementations

impl<T: IsDomNode + AsRef<Node> + AsRef<Element> + 'static> AttributeView for ViewBuilder<T>

AttributeView

pub fn attribute<E: Into<Effect<String>>>(&mut self, name: &str, eff: E)

Create a named attribute on the view that may change over time as a receiver receives a message. Here's an example that builds a gizmo with inital id and class values, and updates the class value whenever a message is received on a Receiver:

pub fn boolean_attribute<E: Into<Effect<bool>>>(&mut self, name: &str, eff: E)

Create (or remove) a boolean attribute on the view that may change its value every time the given receiver receives a message If eff contains a receiver and that receiver receives false it will respond by removing the attribute until it receives true. If eff is a single boolean value, either add or remove the attribute.

impl<T: Clone + IsDomNode> Clone for ViewBuilder<T>

pub fn clone(&self) -> ViewBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: IsDomNode> Default for ViewBuilder<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: IsDomNode + AsRef<Node> + 'static> ElementView for ViewBuilder<T>

ElementView

pub fn element(tag: &str) -> Self

Create a view with the given element tag.

pub fn element_ns(tag: &str, ns: &str) -> Self

Create a view with the given element tag and namespace.

impl<T: IsDomNode + AsRef<EventTarget>> EventTargetView for ViewBuilder<T>

EventTargetView

pub fn on(&mut self, ev_name: &str, tx: Transmitter<Event>)

Transmit an event message on the given transmitter when the named event happens.

pub fn window_on(&mut self, ev_name: &str, tx: Transmitter<Event>)

Transmit an event message on the given transmitter when the named event happens on web_sys::Window.

pub fn document_on(&mut self, ev_name: &str, tx: Transmitter<Event>)

Transmit an event message into the given transmitter when the named event happens on web_sys::Document.

impl<'_> From<&'_ String> for ViewBuilder<Text>

pub fn from(text: &String) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for ViewBuilder<Text>

pub fn from(tag_or_text: &str) -> Self

Performs the conversion.

impl<'_> From<(&'_ String, Receiver<String>)> for ViewBuilder<Text>

pub fn from((now, later): (&String, Receiver<String>)) -> Self

Performs the conversion.

impl<'_> From<(&'_ str, Receiver<String>)> for ViewBuilder<Text>

pub fn from(tuple: (&str, Receiver<String>)) -> Self

Performs the conversion.

impl From<(String, Receiver<String>)> for ViewBuilder<Text>

pub fn from(tuple: (String, Receiver<String>)) -> Self

Performs the conversion.

impl From<Effect<String>> for ViewBuilder<Text>

From instances for ViewBuilder.

Most of these mimic the corresponding From instances for View, the rest are here for the operation of this module.

pub fn from(effect: Effect<String>) -> Self

Performs the conversion.

impl From<Receiver<String>> for ViewBuilder<Text>

pub fn from(later: Receiver<String>) -> Self

Performs the conversion.

impl From<String> for ViewBuilder<Text>

pub fn from(text: String) -> Self

Performs the conversion.

impl<T: IsDomNode + AsRef<Node>> From<ViewBuilder<T>> for View<T>

ViewBuilder can be converted into a fresh View.

pub fn from(builder: ViewBuilder<T>) -> View<T>

Performs the conversion.

impl<P, C> ParentView<Option<ViewBuilder<C>>> for ViewBuilder<P> where
    P: IsDomNode + AsRef<Node>,
    C: IsDomNode + AsRef<Node>, 

pub fn with(&mut self, o_child: Option<ViewBuilder<C>>)

Add a child to this parent.

impl<P, C> ParentView<Vec<ViewBuilder<C>, Global>> for ViewBuilder<P> where
    P: IsDomNode + AsRef<Node>,
    C: IsDomNode + AsRef<Node>, 

pub fn with(&mut self, children: Vec<ViewBuilder<C>>)

Add a child to this parent.

impl<P, C> ParentView<ViewBuilder<C>> for ViewBuilder<P> where
    P: IsDomNode + AsRef<Node>,
    C: IsDomNode + AsRef<Node>, 

ParentView

pub fn with(&mut self, child: ViewBuilder<C>)

Add a child to this parent.

impl<T, C> PatchView<View<C>> for ViewBuilder<T> where
    T: IsDomNode + AsRef<Node>,
    C: IsDomNode + AsRef<Node>, 

PatchView

pub fn patch<S: Clone + Into<View<C>>>(&mut self, rx: Receiver<Patch<S>>)

Patch the view using the Patch messages sent on the given Receiver.

impl<T: IsDomNode + Clone> PostBuildView for ViewBuilder<T>

PostBuildView

type DomNode = T

The type of the inner DOM node.

pub fn post_build(&mut self, transmitter: Transmitter<T>)

After the view is built, transmit its underlying DomNode on the given transmitter.

impl<T: IsDomNode + AsRef<HtmlElement>> StyleView for ViewBuilder<T>

StyleView

pub fn style<E: Into<Effect<String>>>(&mut self, name: &str, eff: E)

Set a CSS property in the style attribute of the view being built. If eff contains a Receiver, messages received will updated the style's value.

impl<T: IsDomNode + AsRef<Node>> TryFrom<Option<ViewBuilder<T>>> for ViewBuilder<T>

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(o_builder: Option<ViewBuilder<T>>) -> Result<ViewBuilder<T>, ()>

Performs the conversion.