smail - v2.0.0

smail/html

This module exposes low-level HTML elements that can be used directly when needed. Because HTML in emails is old and full of client-specific quirks, it is strongly recommended to use the smail/email module instead, which handles all compatibility concerns for you.

That said, this module is useful when you need something not covered by smail/email — for example, building a plain table layout or using a <span> for inline styling.

Types

Element

</> 
pub type Element =
  @internal Element

Values

a

</> 
pub fn a(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

abbr

</> 
pub fn abbr(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

address

</> 
pub fn address(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

advanced

</> 
pub fn advanced(
  tag: String,
  attributes: List(attribute.Attribute),
  children: List(Element),
  void: Bool,
) -> Element

Like element but lets you explicitly control whether the element is void. Use this when you need a custom tag that should be rendered without a closing tag.

area

</> 
pub fn area(attrs: List(attribute.Attribute)) -> Element

b

</> 
pub fn b(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

base

</> 
pub fn base(attrs: List(attribute.Attribute)) -> Element

bdi

</> 
pub fn bdi(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

bdo

</> 
pub fn bdo(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

blockquote

</> 
pub fn blockquote(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

body

</> 
pub fn body(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

br

</> 
pub fn br(attrs: List(attribute.Attribute)) -> Element

caption

</> 
pub fn caption(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

cite

</> 
pub fn cite(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

code

</> 
pub fn code(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

col

</> 
pub fn col(attrs: List(attribute.Attribute)) -> Element

colgroup

</> 
pub fn colgroup(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

data

</> 
pub fn data(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

dd

</> 
pub fn dd(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

del

</> 
pub fn del(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

dfn

</> 
pub fn dfn(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

div

</> 
pub fn div(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

dl

</> 
pub fn dl(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

dt

</> 
pub fn dt(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

element

</> 
pub fn element(
  tag: String,
  attributes: List(attribute.Attribute),
  children: List(Element),
) -> Element

Creates an HTML element with the given tag name, attributes, and children. Void elements (such as <img> or <br>) are detected automatically and rendered without a closing tag.

em

</> 
pub fn em(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

figcaption

</> 
pub fn figcaption(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

figure

</> 
pub fn figure(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

fragment

</> 
pub fn fragment(children: List(Element)) -> Element

Groups multiple elements together without introducing a wrapping tag in the rendered output.

h1

</> 
pub fn h1(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

h2

</> 
pub fn h2(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

h3

</> 
pub fn h3(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

h4

</> 
pub fn h4(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

h5

</> 
pub fn h5(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

h6

</> 
pub fn h6(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element
</> 
pub fn head(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

hr

</> 
pub fn hr(attrs: List(attribute.Attribute)) -> Element

html

</> 
pub fn html(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

i

</> 
pub fn i(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

img

</> 
pub fn img(attrs: List(attribute.Attribute)) -> Element

ins

</> 
pub fn ins(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

kbd

</> 
pub fn kbd(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

li

</> 
pub fn li(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element
</> 
pub fn link(attrs: List(attribute.Attribute)) -> Element

map

</> 
pub fn map(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

Used with elements to define an image map (a clickable link area).

mark

</> 
pub fn mark(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

meta

</> 
pub fn meta(attrs: List(attribute.Attribute)) -> Element

none

</> 
pub fn none() -> Element

Creates an empty element that renders nothing. Useful for conditionally including or omitting content without changing the structure of the tree.

ol

</> 
pub fn ol(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

p

</> 
pub fn p(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

pre

</> 
pub fn pre(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

q

</> 
pub fn q(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

rp

</> 
pub fn rp(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

rt

</> 
pub fn rt(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

ruby

</> 
pub fn ruby(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

s

</> 
pub fn s(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

samp

</> 
pub fn samp(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

small

</> 
pub fn small(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

span

</> 
pub fn span(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

strong

</> 
pub fn strong(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

style

</> 
pub fn style(
  attrs: List(attribute.Attribute),
  css: String,
) -> Element

sub

</> 
pub fn sub(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

sup

</> 
pub fn sup(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

table

</> 
pub fn table(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

tbody

</> 
pub fn tbody(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

td

</> 
pub fn td(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

text

</> 
pub fn text(content: String) -> Element

Creates a text node. HTML special characters in content are escaped automatically.

tfoot

</> 
pub fn tfoot(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

th

</> 
pub fn th(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

thead

</> 
pub fn thead(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

time

</> 
pub fn time(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

title

</> 
pub fn title(
  attrs: List(attribute.Attribute),
  content: String,
) -> Element

tr

</> 
pub fn tr(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

u

</> 
pub fn u(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

ul

</> 
pub fn ul(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

unsafe_raw_html

</> 
pub fn unsafe_raw_html(
  tag: String,
  attributes: List(attribute.Attribute),
  inner_html: String,
) -> Element

Creates an element whose inner content is set directly from a raw HTML string without any escaping. The provided HTML is injected as-is into the output.

Warning: never pass untrusted user input to this function as it will be rendered verbatim, which may introduce XSS vulnerabilities.

var

</> 
pub fn var(
  attrs: List(attribute.Attribute),
  children: List(Element),
) -> Element

wbr

</> 
pub fn wbr(attrs: List(attribute.Attribute)) -> Element
✨ Search Document