Skip to main content
Version: Next

HTML

The html! macro allows you to write HTML and SVG code declaratively. It is similar to JSX (an extension to JavaScript that allows you to write HTML-like code inside of JavaScript).

Important notes

  1. The html! macro only accepts one root html node (you can counteract this by using fragments or iterators)
  2. An empty html! {} invocation is valid and will not render anything
  3. Literals must always be quoted and wrapped in braces: html! { <p>{ "Hello, World" }</p> }
  4. The html! macro will make all tag names lowercase. To use upper case characters (which are required for some SVG elements) use dynamic tag names: html! { <@{"myTag"}></@> }
note

The html! macro can reach the default recursion limit of the compiler. If you encounter compilation errors, add an attribute like #![recursion_limit="1024"] in the crate root to overcome the problem.

Tag Structure​

Tags are based on HTML tags. Components, Elements, and Lists are all based on this tag syntax.

Tags must either self-close <... /> or have a corresponding end tag for each start tag.

use yew::prelude::*;

html! {
  <div id="my_div"></div>
};
use yew::prelude::*;

html! {
  <input id="my_input" />
};
tip

For convenience, elements which usually require a closing tag are allowed to self-close. For example, writing html! { <div class="placeholder" /> } is valid.

Children​

Create complex nested HTML and SVG layouts with ease:

use yew::prelude::*;

html! {
    <div>
        <div data-key="abc"></div>
        <div class="parent">
            <span class="child" value="anything"></span>
            <label for="first-name">{ "First Name" }</label>
            <input type="text" id="first-name" value="placeholder" />
            <input type="checkbox" checked=true />
            <textarea value="write a story" />
            <select name="status">
                <option selected=true disabled=false value="">{ "Selected" }</option>
                <option selected=false disabled=true value="">{ "Unselected" }</option>
            </select>
        </div>
    </div>
};

Lints​

If you compile Yew using a nightly version of the Rust compiler, the macro will warn you about some common pitfalls that you might run into. Of course, you may need to use the stable compiler (e.g. your organization might have a policy mandating it) for release builds, but even if you're using a stable toolchain, running cargo +nightly check might flag some ways that you could improve your HTML code.

At the moment the lints are mostly accessibility-related. If you have ideas for lints, please feel free to chime in on this issue.

Specifying attributes and properties​

Attributes are set on elements in the same way as in normal HTML:

use yew::prelude::*;

let value = "something";
html! { <div attribute={value} /> };

Properties are specified with ~ before the element name:

use yew::prelude::*;

html! { <my-element ~property="abc" /> };
tip

The braces around the value can be ommited if the value is a literal.

What classifies as a literal

Literals are all valid literal expressions in Rust. Note that negative numbers are not literals and thus must be encosed in curly-braces {-6}

Component properties

Component properites are passed as Rust objects and are different from the element attributes/properties described here. Read more about them at Component Properties

Special properties​

There are special properties which don't directly influence the DOM but instead act as instructions to Yew's virtual DOM. Currently, there are two such special props: ref and key.

ref allows you to access and manipulate the underlying DOM node directly. See Refs for more details.

key on the other hand gives an element a unique identifier which Yew can use for optimization purposes.

info

Read more at Lists

Conditional Rendering​

Markup can be rendered conditionally by using Rust's conditional structures. ' + 'Currently only if and if let are supported.

use yew::prelude::*;

html! {
  if true {
      <p>{ "True case" }</p>
  }
};
info

Read more at Conditional Rendering