Struct seed::virtual_dom::node::el::El

pub struct El<Ms> {
    pub tag: Tag,
    pub attrs: Attrs,
    pub style: Style,
    pub event_handler_manager: EventHandlerManager<Ms>,
    pub children: Vec<Node<Ms>>,
    pub namespace: Option<Namespace>,
    pub node_ws: Option<Node>,
    pub refs: Vec<SharedNodeWs>,
    pub key: Option<ElKey>,
    pub insert_handlers: Vec<InsertEventHandler<Ms>>,
}

A component in our virtual DOM.

Note: Listeners in El’s event_handler_manager are not cloned, but recreated during VDOM patching.

MDN reference web_sys reference

Fields

tag: Tag

attrs: Attrs

style: Style

event_handler_manager: EventHandlerManager<Ms>

children: Vec<Node<Ms>>

namespace: Option<Namespace>

node_ws: Option<Node>

The actual DOM element/node.

refs: Vec<SharedNodeWs>

key: Option<ElKey>

insert_handlers: Vec<InsertEventHandler<Ms>>

Implementations

impl<Ms> El<Ms>

pub fn empty(tag: Tag) -> Self

Create an empty element, specifying only the tag

pub fn empty_svg(tag: Tag) -> Self

Create an empty SVG element, specifying only the tag

pub fn from_html(namespace: Option<&Namespace>, html: &str) -> Vec<Node<Ms>>

Create elements from an HTML string.

pub fn add_child(&mut self, element: Node<Ms>) -> &mut Self

Add a new child to the element

pub fn add_attr(
    &mut self,
    key: impl Into<Cow<'static, str>>,
    val: impl Into<AtValue>
) -> &mut Self

Add an attribute (eg class, or href)

pub fn add_class(&mut self, name: impl Into<Cow<'static, str>>) -> &mut Self

Add a class. May be cleaner than add_attr

pub fn add_style(
    &mut self,
    key: impl Into<St>,
    val: impl Into<CSSValue>
) -> &mut Self

Add a new style (eg display, or height),

pub fn add_event_handler(
    &mut self,
    event_handler: EventHandler<Ms>
) -> &mut Self

Add a new event handler.

pub fn add_text(&mut self, text: impl Into<Cow<'static, str>>) -> &mut Self

Add a text node to the element. (ie between the HTML tags).

pub fn replace_text(&mut self, text: impl Into<Cow<'static, str>>) -> &mut Self

Replace the element’s text. Removes all text nodes from element, then adds the new one.

pub fn get_text(&self) -> String

pub fn warn_about_script_tags(&self)

Warn user about potential bugs when having scripts and Takeover mount type.

pub fn strip_ws_nodes_from_self_and_children(&mut self)

Remove websys nodes.

pub const fn is_custom(&self) -> bool

Is it a custom element?

Trait Implementations

impl<Ms> Clone for El<Ms>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ms: Debug> Debug for El<Ms>

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

Formats the value using the given formatter.

impl<Ms> Display for El<Ms>

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

Formats the value using the given formatter.

impl<Ms> From<&'_ Element> for El<Ms>

fn from(ws_el: &Element) -> Self

Create a vdom node from a web_sys::Element. Used in creating elements from html and markdown strings. Includes children, recursively added.

impl<Ms: 'static, OtherMs: 'static> MessageMapper<Ms, OtherMs> for El<Ms>

fn map_msg(self, f: impl FnOnce(Ms) -> OtherMs + 'static + Clone) -> El<OtherMs>

Maps an element’s message to have another message.

This allows third party components to integrate with your application without having to know about your Msg type beforehand.

Note

There is an overhead to calling this versus keeping all messages under one type. The deeper the nested structure of children, the more time this will take to run.

type SelfWithOtherMs = El<OtherMs>

impl<Ms> UpdateEl<Ms> for El<Ms>

fn update_el(self, el: &mut El<Ms>)