This is unreleased documentation for Yew Next version.

For up-to-date documentation, see the latest version on docs.rs.

Type Alias Html

Help

pub type Html = VNode;

Expand description

A type which expected as a result of view function implementation.

Aliased Type§

enum Html {
    // some variants omitted
}

Variants§

Implementations

impl VNode

pub fn key(&self) -> Option<&Key>

pub fn has_key(&self) -> bool

Returns true if the VNode has a key.

pub fn to_vlist_mut(&mut self) -> &mut VList

Acquires a mutable reference of current VNode as a VList.

Creates a VList with the current node as the first child if current VNode is not a VList.

pub fn from_html_unchecked(html: AttrValue) -> Self

Create a VNode from a string of HTML

§Behavior in browser

In the browser, this function creates an element with the same XML namespace as the parent, sets the passed HTML to its innerHTML and inserts the contents of it into the DOM.

§Behavior on server

When rendering on the server, the contents of HTML are directly injected into the HTML stream.

§Warning

The contents are not sanitized or validated. You, as the developer, are responsible to ensure the HTML string passed to this method are valid and not malicious

§Example

use yew::{html, AttrValue, Html};
let parsed = Html::from_html_unchecked(AttrValue::from("<div>content</div>"));
let _: Html = html! {
    <div>
        {parsed}
    </div>
};

Trait Implementations§

impl From<ChildrenRenderer<VNode>> for Html

fn from(val: ChildrenRenderer<Html>) -> Self

Converts to this type from the input type.

impl IntoHtmlResult for Html

fn into_html_result(self) -> HtmlResult

Performs the conversion.

impl Clone for VNode

fn clone(&self) -> VNode

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for VNode

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

Formats the value using the given formatter. Read more

impl Default for VNode

fn default() -> Self

Returns the “default value” for a type. Read more

impl<T: ToString> From<T> for VNode

fn from(value: T) -> Self

Converts to this type from the input type.

impl<COMP> From<VChild<COMP>> for VNode
where COMP: BaseComponent,

fn from(vchild: VChild<COMP>) -> Self

Converts to this type from the input type.

impl From<VComp> for VNode

fn from(vcomp: VComp) -> Self

Converts to this type from the input type.

impl From<VList> for VNode

fn from(vlist: VList) -> Self

Converts to this type from the input type.

impl From<VPortal> for VNode

fn from(vportal: VPortal) -> Self

Converts to this type from the input type.

impl From<VSuspense> for VNode

fn from(vsuspense: VSuspense) -> Self

Converts to this type from the input type.

impl From<VTag> for VNode

fn from(vtag: VTag) -> Self

Converts to this type from the input type.

impl From<VText> for VNode

fn from(vtext: VText) -> Self

Converts to this type from the input type.

impl<A: Into<VNode>> FromIterator<A> for VNode

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self

Creates a value from an iterator. Read more

impl ImplicitClone for VNode

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as Read more

impl IntoPropValue<ChildrenRenderer<VNode>> for VNode

fn into_prop_value(self) -> ChildrenRenderer<VNode>

Convert self to a value of a Properties struct.

impl PartialEq for VNode

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl StructuralPartialEq for VNode