Struct yew::virtual_dom::VTag

pub struct VTag {
    pub reference: Option<Element>,
    pub listeners: Vec<Rc<dyn Listener>>,
    pub attributes: Attributes,
    pub children: VList,
    pub value: Option<AttrValue>,
    pub kind: Option<AttrValue>,
    pub checked: bool,
    pub node_ref: NodeRef,
    pub key: Option<Key>,
    // some fields omitted
}

A type for a virtual Element representation.

Fields

reference: Option<Element>

A reference to the DOM Element.

listeners: Vec<Rc<dyn Listener>>

List of attached listeners.

attributes: Attributes

List of attributes.

children: VList

List of children nodes

value: Option<AttrValue>

Contains a value of an InputElement.

kind: Option<AttrValue>

Contains kind value of an InputElement.

checked: bool

Represents checked attribute of input. It exists to override standard behavior of checked attribute, because in original HTML it sets defaultChecked value of InputElement, but for reactive frameworks it’s more useful to control checked value of an InputElement.

node_ref: NodeRef

A node reference used for DOM access in Component lifecycle methods

key: Option<Key>

Implementations

impl VTag

pub fn new(tag: impl Into<Cow<'static, str>>) -> Self

Creates a new VTag instance with tag name (cannot be changed later in DOM).

pub fn tag(&self) -> &str

Returns tag of an Element. In HTML tags are always uppercase.

pub fn add_child(&mut self, child: VNode)

Add VNode child.

pub fn add_children(&mut self, children: impl IntoIterator<Item = VNode>)

Add multiple VNode children.

pub fn set_value(&mut self, value: impl IntoOptPropValue<AttrValue>)

Sets value for an InputElement.

pub fn set_kind(&mut self, value: impl IntoOptPropValue<AttrValue>)

Sets kind property of an InputElement. Same as set type attribute.

pub fn set_checked(&mut self, value: bool)

Sets checked property of an InputElement. (Not a value of node’s attribute).

pub fn add_attribute(&mut self, key: &'static str, value: impl Into<AttrValue>)

Adds a key-value pair to attributes

Not every attribute works when it set as an attribute. We use workarounds for: type/kind, value and checked.

pub fn set_attributes(&mut self, attrs: impl Into<Attributes>)

Sets attributes to a virtual node.

Not every attribute works when it set as an attribute. We use workarounds for: type/kind, value and checked.

pub fn add_listener(&mut self, listener: Rc<dyn Listener>)

Adds new listener to the node. It’s boxed because we want to keep it in a single list. Later Listener::attach will attach an actual listener to a DOM node.

pub fn add_listeners(&mut self, listeners: Vec<Rc<dyn Listener>>)

Adds new listeners to the node. They are boxed because we want to keep them in a single list. Later Listener::attach will attach an actual listener to a DOM node.

Trait Implementations

impl Clone for VTag

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VTag

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

Formats the value using the given formatter.

impl From<VTag> for VNode

fn from(vtag: VTag) -> Self

Performs the conversion.

impl PartialEq<VTag> for VTag

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

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

#[must_use]

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

This method tests for !=.