Struct yew::virtual_dom::VTag

pub struct VTag {
    pub node_ref: NodeRef,
    pub attributes: Attributes,
    pub key: Option<Key>,
    /* private fields */
}

A type for a virtual Element representation.

Fields

node_ref: NodeRef

A node reference used for DOM access in Component lifecycle methods

attributes: Attributes

List of attributes.

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 children(&self) -> Option<&VNode>

Returns a reference to the children of this VTag, if the node can have children

pub fn children_mut(&mut self) -> Option<&mut VNode>

Returns a mutable reference to the children of this VTag, if the node can have children

pub fn into_children(self) -> Option<VNode>

Returns the children of this VTag, if the node can have children

pub fn value(&self) -> Option<&AttrValue>

Returns the value of an InputElement or TextArea

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

Sets value for an InputElement or TextArea

pub fn checked(&self) -> Option<bool>

Returns checked property of an InputElement. (Does not affect the value of the node’s attribute).

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

Sets checked property of an InputElement. (Does not affect the value of the node’s attribute).

pub fn preserve_checked(&mut self)

Keeps the current value of the checked property of an InputElement. (Does not affect the value of the 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: value and checked.

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

Set the given key as property on the element

js_sys::Reflect is used for setting properties.

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: value and checked.

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

Add event listener on the VTag’s Element. Returns true if the listener has been added, false otherwise.

pub fn set_listeners(&mut self, listeners: Box<[Option<Rc<dyn Listener>>]>)

Set event listeners on the VTag’s Element

Trait Implementations

impl Clone for VTag

fn clone(&self) -> VTag

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

Converts to this type from the input type.

impl PartialEq for VTag

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.