Html

:= []

Build and render small server-generated HTML documents.

Text and attribute values are escaped by default. Tag and attribute names supplied to the generic constructors are trusted syntax and must be constants, not user input.

page = Html.html([], [
    Html.body([], [
        Html.h1([], [Html.text("Hello <Roc>")]),
        Html.a([Attribute.href("/account")], [Html.text("Account")]),
    ]),
])

response = Response.from_status(200)
    .with_headers([{ name: "Content-Type", value: "text/html; charset=utf-8" }])
    .with_body(Str.to_utf8(Html.render(page)))

text : Str -> HtmlNode

Construct escaped text. Use this for all untrusted or dynamic text.

dangerously_include_unescaped_html : Str -> HtmlNode

Insert trusted HTML without escaping it.

Never pass user input or other untrusted content to this function.

element : Str, List(Attribute), List(HtmlNode) -> HtmlNode

Construct a normal element with a trusted tag name.

void_element : Str, List(Attribute) -> HtmlNode

Construct a void element with a trusted tag name.

render : HtmlNode -> Str

Render a complete HTML document beginning with <!DOCTYPE html>.

render_fragment : List(HtmlNode) -> Fragment

Render sibling nodes as one HTML fragment.

render_document : HtmlNode -> Document

Render one root node as a complete HTML document.

fragment_from_rendered_str : Str -> Fragment

Treat an already-rendered string as a patchable fragment.

This is the explicit compatibility boundary for another renderer or trusted literal markup. Dynamic or untrusted text belongs in [text].

render_without_doc_type : HtmlNode -> Str

Render a node without adding a document type declaration.

html : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an html element.

head : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a head element.

body : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a body element.

title : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a title element.

header : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a header element.

nav : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a nav element.

main : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a main element.

div : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a div element.

span : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a span element.

p : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a p element.

a : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an a element.

ul : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a ul element.

li : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an li element.

h1 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h1 element.

h2 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h2 element.

h3 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h3 element.

h4 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h4 element.

h5 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h5 element.

h6 : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an h6 element.

form : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a form element.

button : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a button element.

label : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a label element.

table : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a table element.

thead : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a thead element.

tbody : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a tbody element.

tr : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a tr element.

th : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a th element.

td : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a td element.

svg : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an svg element.

select : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct a select element.

option : List(
    Attribute,
), List(
    HtmlNode,
) -> HtmlNode

Construct an option element.

input : List(
    Attribute,
) -> HtmlNode

Construct an input void element.

meta : List(
    Attribute,
) -> HtmlNode

Construct a meta void element.

link : List(
    Attribute,
) -> HtmlNode

Construct a link void element.

br : List(
    Attribute,
) -> HtmlNode

Construct a br void element.

Fragment

:= [Fragment(Str)]

Rendered sibling HTML nodes for APIs that require an HTML fragment.

This nominal boundary distinguishes rendered markup from ordinary text. It does not claim that the fragment has particular IDs or matches a DOM selector.

to_str : Fragment -> Str

Return the rendered fragment text.

to_bytes : Fragment -> List(U8)

Return the rendered fragment bytes.

Document

:= [Document(Str)]

A complete rendered HTML document including its document type.

to_str : Document -> Str

Return the rendered document text.

to_bytes : Document -> List(U8)

Return the rendered document bytes.

Node : HtmlNode

An HTML node. Prefer this module's constructors so text and attribute values are escaped consistently.