lustre/attribute

Note: this is a release candidate for v4.0.0 and documentation is still a work in progress. If you spot an issue with docs or the library, or would like to get involved, please open an issue or a pull request.

Types

Attribute

</>

The Attribute type encompasses HTML attributes, DOM properties, and event listeners.

pub type Attribute(msg) =
  vdom.Attribute(msg)

Functions

accept

</>

pub fn accept(types: List(String)) -> Attribute(a)

accept_charset

</>

pub fn accept_charset(types: List(String)) -> Attribute(a)

alt

</>

pub fn alt(text: String) -> Attribute(a)

attribute

</>

pub fn attribute(name: String, value: String) -> Attribute(a)

autocomplete

</>

pub fn autocomplete(name: String) -> Attribute(a)

autofocus

</>

pub fn autofocus(should_autofocus: Bool) -> Attribute(a)

autoplay

</>

pub fn autoplay(should_autoplay: Bool) -> Attribute(a)

checked

</>

pub fn checked(is_checked: Bool) -> Attribute(a)

class

</>

pub fn class(name: String) -> Attribute(a)

Note: unlike most attributes, multiple class attributes are merged with any existing other classes on an element.

classes

</>

pub fn classes(names: List(#(String, Bool))) -> Attribute(a)

cols

</>

pub fn cols(val: Int) -> Attribute(a)

controls

</>

pub fn controls(visible: Bool) -> Attribute(a)

disabled

</>

pub fn disabled(is_disabled: Bool) -> Attribute(a)

download

</>

pub fn download(filename: String) -> Attribute(a)

for

</>

pub fn for(id: String) -> Attribute(a)

height

</>

pub fn height(val: Int) -> Attribute(a)

href

</>

pub fn href(uri: String) -> Attribute(a)

id

</>

pub fn id(name: String) -> Attribute(a)

loop

</>

pub fn loop(should_loop: Bool) -> Attribute(a)

map

</>

pub fn map(attr: Attribute(a), f: fn(a) -> b) -> Attribute(b)

The Attribute type is parameterised by the type of messages it can produce from events handlers. Sometimes you might end up with an attribute from a library or module that produces a different type of message: this function lets you map the messages produced from one type to another.

max

</>

pub fn max(val: String) -> Attribute(a)

min

</>

pub fn min(val: String) -> Attribute(a)

msg

</>

pub fn msg(uri: String) -> Attribute(a)

name

</>

pub fn name(name: String) -> Attribute(a)

none

</>

pub fn none() -> Attribute(a)

on

</>

pub fn on(
  name: String,
  handler: fn(Dynamic) -> Result(a, b),
) -> Attribute(a)

pattern

</>

pub fn pattern(regex: String) -> Attribute(a)

placeholder

</>

pub fn placeholder(text: String) -> Attribute(a)

property

</>

pub fn property(name: String, value: a) -> Attribute(b)

readonly

</>

pub fn readonly(is_readonly: Bool) -> Attribute(a)

rel

</>

pub fn rel(relationship: String) -> Attribute(a)

required

</>

pub fn required(is_required: Bool) -> Attribute(a)

role

</>

pub fn role(name: String) -> Attribute(a)

rows

</>

pub fn rows(val: Int) -> Attribute(a)

selected

</>

pub fn selected(is_selected: Bool) -> Attribute(a)

src

</>

pub fn src(uri: String) -> Attribute(a)

step

</>

pub fn step(val: String) -> Attribute(a)

style

</>

pub fn style(properties: List(#(String, String))) -> Attribute(a)

Note: unlike most attributes, multiple style attributes are merged with any existing other styles on an element. Styles added later in the list will override styles added earlier.

target

</>

pub fn target(target: String) -> Attribute(a)

type_

</>

pub fn type_(name: String) -> Attribute(a)

value

</>

pub fn value(val: String) -> Attribute(a)

width

</>

pub fn width(val: Int) -> Attribute(a)

wrap

</>

pub fn wrap(mode: String) -> Attribute(a)