lustre

To read the full documentation for this module, please visit https://lustre.build/api/lustre

Types

App

pub opaque type App(flags, model, msg)

Error

</>

pub type Error {
  AppAlreadyStarted
  AppNotYetStarted
  BadComponentName
  ComponentAlreadyRegistered
  ElementNotFound
  NotABrowser
}

Constructors

```
AppAlreadyStarted
```
```
AppNotYetStarted
```
```
BadComponentName
```
```
ComponentAlreadyRegistered
```
```
ElementNotFound
```
```
NotABrowser
```

Functions

application

</>

pub fn application(
  init: fn(a) -> #(b, Effect(c)),
  update: fn(b, c) -> #(b, Effect(c)),
  view: fn(b) -> Element(c),
) -> App(a, b, c)

component

</>

pub fn component(
  name: String,
  init: fn() -> #(a, Effect(b)),
  update: fn(a, b) -> #(a, Effect(b)),
  view: fn(a) -> Element(b),
  on_attribute_change: Dict(
    String,
    fn(Dynamic) -> Result(b, List(DecodeError)),
  ),
) -> Result(Nil, Error)

destroy

</>

pub fn destroy(app: App(a, b, c)) -> Result(Nil, Error)

element

</>

pub fn element(element: Element(a)) -> App(Nil, Nil, a)

is_browser

</>

pub fn is_browser() -> Bool

is_registered

</>

pub fn is_registered(name: String) -> Bool

simple

</>

pub fn simple(
  init: fn(a) -> b,
  update: fn(b, c) -> b,
  view: fn(b) -> Element(c),
) -> App(a, b, c)

start

</>

pub fn start(
  app: App(a, b, c),
  selector: String,
  flags: a,
) -> Result(fn(c) -> Nil, Error)