Struct mogwai::view::dom::View

pub struct View<T: IsDomNode> { /* fields omitted */ }

A widget that may contain a bundled network of html elements, callback closures and receivers. This wraps a Javascript DOM node and maintains lists and maps needed to orchestrate user interaction.

Implementations

impl<T: IsDomNode> View<T>

pub fn dom_ref(&self) -> Ref<'_, T>

Return a reference to the underlying DOM element.

pub fn store_view(&mut self, child: View<Node>)

Stores a View without adding its element to the DOM.

NOTE: This is for use by helper libraries like mogwai-hydrator and is not

intended to be called by downsteam users.

pub fn stored_views_len(&self) -> usize

Returns the number of views being stored in this view.

pub fn as_ssr_node(&self) -> SsrNode

Create a server side rendering node from this View. Instead of using this, consider View::html_string.

pub fn html_string(&self) -> String

A string value of this View. This is equivalent to Element.outerHtml in JS.

pub fn wrapping(_element: T) -> View<T>

Create a new View wrapping a T that can be dereferenced to a Node.

Panics

Panics if used outside of a wasm32 target.

pub fn try_cast<To: IsDomNode>(self) -> Result<View<To>, Self>

Attempt to cast the view.

Note

On wasm32 this performs a check on the inner element to determine if the element can be downcast to the desired type. On other compilation targets this function always returns Ok.

pub fn upcast<To: IsDomNode>(self) -> View<To> where
    T: AsRef<To>,
    To: IsDomNode, 

Cast the given View to contain the inner DOM node of another type. That type must be dereferencable from the given View.

pub fn downcast<To: IsDomNode + AsRef<Node>>(self) -> Result<View<To>, View<T>>

Attempt to downcast the inner element.

Note

On wasm32 this performs a check on the inner element to determine if the element can be downcast to the desired type. On other compilation targets this function always returns Ok.

pub fn forget(self) -> Result<(), JsValue>

Run this gizmo forever without appending it to anything.

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

pub fn run_in_container(self, container: &Node) -> Result<(), JsValue>

Run this gizmo in a parent container forever, never dropping it.

pub fn run(self) -> Result<(), JsValue>

Run this gizmo in the document body forever, never dropping it.

impl View<Text>

pub fn text(text: &str) -> View<Text>

Create a new text node View.

pub fn rx_text(&mut self, rx: Receiver<String>)

Use the given receiver to update this text node View's text.

Trait Implementations

impl<T: IsDomNode + AsRef<Element>> AttributeView for View<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 View<T>

pub fn clone(&self) -> View<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 View<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: IsDomNode> ElementView for View<T>

ElementView

pub fn element(name: &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 View<T>

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 View<Text>

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

Performs the conversion.

impl<'a> From<&'a str> for View<Text>

pub fn from(s: &'a str) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

From instances for View

• String, str etc get converted into View<Text> - ie text nodes, with their initial inner text set to the input string.
• Receiver get converted into View<Text> with their inner text initially empty and then later set by the messages sent to the receiver.
• Effect gets converted into View<Text> with possibly an initial string and updates through the receiver.
• Any raw DOM element T gets wrapped by a view to make View<T>
• Gizmo<C> returns its view, a View<<C::as Component>::DomNode>.

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

Performs the conversion.

impl<T> From<Gizmo<T>> for View<<T as Component>::DomNode> where
    T: Component,
    <T as Component>::DomNode: JsCast + AsRef<Node>, 

pub fn from(gizmo: Gizmo<T>) -> Self

Performs the conversion.

impl From<String> for View<Text>

pub fn from(s: String) -> Self

Performs the conversion.

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

pub fn from(el: T) -> View<T>

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<S: IsDomNode + AsRef<Node>, T: IsDomNode + AsRef<Node>> ParentView<Option<View<S>>> for View<T>

pub fn with(&mut self, o_view: Option<View<S>>)

Add a child to this parent.

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

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

Add a child to this parent.

impl<S: IsDomNode + AsRef<Node>, T: IsDomNode + AsRef<Node>> ParentView<View<S>> for View<T>

ParentView

pub fn with(&mut self, view: View<S>)

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, C> PatchView<View<C>> for View<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> PostBuildView for View<T>

PostBuildView

type DomNode = T

The type of the inner DOM node.

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

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

impl<T: IsDomNode + AsRef<HtmlElement>> StyleView for View<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<View<T>>> for View<T>

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(o_view: Option<View<T>>) -> Result<View<T>, ()>

Performs the conversion.