lustre - v1.0.0

lustre/element

Types

Element

</> 
pub external type Element(action)

Functions

a

</> 
pub fn a(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

abbr

</> 
pub fn abbr(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

address

</> 
pub fn address(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

area

</> 
pub fn area(attributes: List(Attribute(a))) -> Element(a)

article

</> 
pub fn article(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

aside

</> 
pub fn aside(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

audio

</> 
pub fn audio(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

b

</> 
pub fn b(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

base

</> 
pub fn base(attributes: List(Attribute(a))) -> Element(a)

bdi

</> 
pub fn bdi(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

bdo

</> 
pub fn bdo(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

blockquote

</> 
pub fn blockquote(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

body

</> 
pub fn body(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

br

</> 
pub fn br(attributes: List(Attribute(a))) -> Element(a)

button

</> 
pub fn button(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

canvas

</> 
pub fn canvas(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

caption

</> 
pub fn caption(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

cite

</> 
pub fn cite(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

code

</> 
pub fn code(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

col

</> 
pub fn col(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

colgroup

</> 
pub fn colgroup(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

datalist

</> 
pub fn datalist(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

dd

</> 
pub fn dd(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

del

</> 
pub fn del(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

details

</> 
pub fn details(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

dfn

</> 
pub fn dfn(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

dialog

</> 
pub fn dialog(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

div

</> 
pub fn div(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

dl

</> 
pub fn dl(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

dt

</> 
pub fn dt(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

em

</> 
pub fn em(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

embed

</> 
pub fn embed(attributes: List(Attribute(a))) -> Element(a)

fieldset

</> 
pub fn fieldset(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

figcaption

</> 
pub fn figcaption(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

figure

</> 
pub fn figure(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)
</> 
pub fn footer(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

form

</> 
pub fn form(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

fragment

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

A fragment doesn’t appear in the DOM, but allows us to treat a list of elements as if it were a single one.

h1

</> 
pub fn h1(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

h2

</> 
pub fn h2(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

h3

</> 
pub fn h3(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

h4

</> 
pub fn h4(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

h5

</> 
pub fn h5(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

h6

</> 
pub fn h6(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)
</> 
pub fn head(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)
</> 
pub fn header(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

hr

</> 
pub fn hr(attributes: List(Attribute(a))) -> Element(a)

html

</> 
pub fn html(attributes: List(Attribute(a)), head: Element(a), body: Element(
    a,
  )) -> Element(a)

i

</> 
pub fn i(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

iframe

</> 
pub fn iframe(attributes: List(Attribute(a))) -> Element(a)

img

</> 
pub fn img(attributes: List(Attribute(a))) -> Element(a)

input

</> 
pub fn input(attributes: List(Attribute(a))) -> Element(a)

ins

</> 
pub fn ins(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

kbd

</> 
pub fn kbd(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

label

</> 
pub fn label(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

legend

</> 
pub fn legend(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

li

</> 
pub fn li(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

main

</> 
pub fn main(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

map

</> 
pub external fn map(
  element: Element(a),
  f: fn(a) -> b,
) -> Element(b)

Transforms the actions produced by some element.

map_

</> 
pub fn map_(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

mark

</> 
pub fn mark(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

mathml

</> 
pub fn mathml(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)
</> 
pub fn menu(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

meta

</> 
pub fn meta(attributes: List(Attribute(a))) -> Element(a)

meter

</> 
pub fn meter(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)
</> 
pub fn nav(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

node

</> 
pub external fn node(
  tag: String,
  attributes: List(Attribute(action)),
  children: List(Element(action)),
) -> Element(action)

Construct a plain HTML element or registered Web Component by providing the tag name, a list of attributes (including event handlers), and a list of child elements.

noscript

</> 
pub fn noscript(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

object

</> 
pub fn object(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

ol

</> 
pub fn ol(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

optgroup

</> 
pub fn optgroup(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

option

</> 
pub fn option(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

output

</> 
pub fn output(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

p

</> 
pub fn p(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

param

</> 
pub fn param(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

picture

</> 
pub fn picture(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

portal

</> 
pub fn portal(attributes: List(Attribute(a))) -> Element(a)

pre

</> 
pub fn pre(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

progress

</> 
pub fn progress(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

rp

</> 
pub fn rp(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

rt

</> 
pub fn rt(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

ruby

</> 
pub fn ruby(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

s

</> 
pub fn s(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

samp

</> 
pub fn samp(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

section

</> 
pub fn section(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

select

</> 
pub fn select(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

slot

</> 
pub fn slot(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

small

</> 
pub fn small(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

source

</> 
pub fn source(attributes: List(Attribute(a))) -> Element(a)

span

</> 
pub fn span(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

stateful

</> 
pub external fn stateful(
  init: state,
  render: fn(state, fn(state) -> Nil) -> Element(action),
) -> Element(action)

A stateful element is exactly what it sounds like: some element with local encapsulated state! The render function we must provide is called with the element’s current state as well as a function to set a new state. Whenever that function is called, the element is re-rendered.

You might be wondering where the stateless version of this function is. Those are just regular Gleam functions that return Elements!

strong

</> 
pub fn strong(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

style

</> 
pub fn style(attributes: List(Attribute(a)), css: String) -> Element(
  a,
)

sub

</> 
pub fn sub(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

summary

</> 
pub fn summary(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

sup

</> 
pub fn sup(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

svg

</> 
pub fn svg(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

table

</> 
pub fn table(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

tbody

</> 
pub fn tbody(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

td

</> 
pub fn td(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

template

</> 
pub fn template(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

text

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

Render a Gleam string as an HTML text node.

textarea

</> 
pub fn textarea(attributes: List(Attribute(a))) -> Element(a)

tfoot

</> 
pub fn tfoot(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

th

</> 
pub fn th(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

thead

</> 
pub fn thead(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

time

</> 
pub fn time(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

title

</> 
pub fn title(attributes: List(Attribute(a)), name: String) -> Element(
  a,
)

tr

</> 
pub fn tr(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

track

</> 
pub fn track(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

u

</> 
pub fn u(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

ul

</> 
pub fn ul(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

var_

</> 
pub fn var_(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

video

</> 
pub fn video(attributes: List(Attribute(a)), children: List(
    Element(a),
  )) -> Element(a)

wbr

</> 
pub fn wbr(attributes: List(Attribute(a))) -> Element(a)
✨