Skip to main content

Crate hatmil

Crate hatmil 

Source
Expand description

Hatmil is an HTML builder for Rust. It can be used to create or modify web pages dynamically, including inline SVG.

With a Tree, there are two “root” methods:

  • html for a full document, including DOCTYPE declaration
  • root for a snippet, starting from any root element (HTML or SVG)

In either case, an element struct is returned which borrows from the Tree.

Each element has methods for setting valid attributes, such as id. There are also methods for adding permitted child elements.

use hatmil::Tree;

let mut tree = Tree::new();
let mut html = tree.html();
let mut body = html.body();
body.p().id("para").cdata("Graph");
assert_eq!(
    String::from(tree),
    "<!DOCTYPE html><html><body><p id=\"para\">Graph</p></body></html>"
);

Text content (character data) can be added using the cdata or cdata_len methods on an element. Special HTML characters will automatically be replaced by character references, as needed (for content which has already been escaped, use the raw method). The close method can be used to close the final open element.

After creating the tree, use String::from(tree) to get the resulting HTML. Any open tags will be closed automatically. Display is also implemented, enabling the use of format or to_string().

use hatmil::{Tree, html::Div};

let mut tree = Tree::new();
let mut div = tree.root::<Div>();
div.button().class("rounded").cdata("Press Me!");
assert_eq!(
    String::from(tree),
    "<div><button class=\"rounded\">Press Me!</button></div>"
);

§Method Names

In most cases, element methods match the HTML tag exactly. But due to clashes with attribute names, some methods for creating child elements have an _el suffix:

  • abbr_el on Th, clash with abbr attribute
  • cite_el on BlockQuote and Q, clash with cite attribute
  • form_el on FieldSet, clash with form attribute
  • slot_el on many elements, clash with slot global attribute
  • style_el on Head, NoScript and SVG elements, clash with style global attribute
  • title_el on Head and SVG Style, clash with title global attribute

Some HTML names clash with Rust keywords. In these cases, raw identifiers must be used to call those methods:

  • r#as on Link
  • r#async on Script
  • r#for on Label and Output
  • r#in on multiple SVG filter elements
  • r#loop on Audio and Video
  • r#type on multiple HTML and SVG elements
  • r#use (SVG element)

Modules§

html
HTML Elements – HyperText Markup Language
svg
SVG Elements – Scalable Vector Graphics

Structs§

PathDefBuilder
SVG Path definition builder
PolyPointBuilder
SVG Polygon / Polyline point builder
Tree
HTML tree builder
Value
A value of an attribute or text content

Type Aliases§

PageDeprecated
Renamed to Tree; will be removed in a future release