E.g. id="toast".

Either a tag, a comment, or text data in the markup.

Same as to_string but render void tags as XML-style self-closing tags.

• since 3.3.0.

Same as pp but render void tags as XML-style self-closing tags.

• since 3.3.0.

Attributes can be created from typed values.

Special handling for string-value attributes so they can use format strings i.e. string interpolation.

A 'standard' tag with attributes and children.

A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.

Tags which can have attributes but can contain only text. The text can be formatted.

attr name is a new attribute which does not carry any payload. E.g.

let required = attr "required"

• since 0.1.0.

string_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.

• parameter raw

  (default false) whether to inject the raw text or to escape it. Note that Dream does not support escaping inline JavaScript nor CSS, so neither does dream-html: https://github.com/aantron/dream/tree/master/example/7-template#security.

Convenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.

Examples

a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
  ==>
  <a href="/blog?tags=iamsafe%22%3E%3C/a%3E%3Cscript%3Ealert('Pwned')%3C/script%3E">Tags: tag1 | tag2</a>

                                                                                                 a [href "/foo?a=1&b=2 3&c=4<5&d=6>5"] [txt "Test"]
                                                                                                 ==>
                                                                                                 <a href="/foo?a=1&amp;b=2%203&amp;c=4%3C5&amp;d=6%3E5">Test</a>

Build a tag which can contain only text.

• parameter raw

  (default false) whether to inject the raw text or to escape it. Note that Dream does not support escaping inline JavaScript nor CSS, so neither does dream-html: https://github.com/aantron/dream/tree/master/example/7-template#security.

A text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:

b [] [txt "Hello, %s!" name]

Or without interpolation:

b [] [txt "Bold of you."]

HTML-escapes the text value. You can use the ~raw param to bypass escaping:

let user_input = "<script>alert('I like HTML injection')</script>" in
  txt ~raw:true "%s" user_input

A comment that will be embedded in the rendered HTML, i.e. <!-- comment -->. The text is HTML-escaped.

Add an attribute to a tag.

let toast msg = p [id "toast"] [txt "%s" msg]
  let toast_oob = toast "ok." +@ Hx.swap_oob "true"

• raises Invalid_argument

  if the node is not a tag (i.e. if it is a text or comment node).

• since 0.0.3.

Remove an attribute from a tag.

• raises Invalid_argument

  if the node is not a tag (i.e. if it is a text or comment node).

• since 0.0.3.

Get the value of an existing attribute.

let toast = p [id "toast"] [txt "OK."]
  let toast_id = toast.@["id"]

• raises Invalid_argument

  if the node is not a tag (i.e. if it is a text or comment node).

• raises Not_found

  if the tag does not have the given attribute.

• since 0.0.3.

Get whether a node is null (empty) or not. Useful for conditional rendering of UIs when you are passed in a node and you don't know if it's empty or not.

• since 1.2.0.

Get whether an attribute is null (empty) or not.

• since 1.2.0.

All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/

htmx support https://htmx.org/reference/