Skip to main content Link Menu Expand (external link) Document Search Copy Copied

React overview

A specialization of Html that uses React as renderer.

Added in v0.5.0


Table of contents


Functor

map

map() is Html.map() with Html type constrained to the specialized version for React.

Signature

export declare function map<A, Msg>(f: (a: A) => Msg): (ha: Html<A>) => Html<Msg>

Added in v0.5.0

constructors

program

program() is Html.program() with Html type constrained to the specialized version for React.

Signature

export declare function program<Model, Msg>(
  init: [Model, Cmd<Msg>],
  update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
  view: (model: Model) => html.Html<Dom, Msg>,
  subscriptions?: (model: Model) => Sub<Msg>
): Program<Model, Msg>

Added in v0.5.0

programWithFlags

Same as program() but with Flags that can be passed when the Program is created in order to manage initial values.

Signature

export declare function programWithFlags<Flags, Model, Msg>(
  init: (flags: Flags) => [Model, Cmd<Msg>],
  update: (msg: Msg, model: Model) => [Model, Cmd<Msg>],
  view: (model: Model) => html.Html<Dom, Msg>,
  subscriptions?: (model: Model) => Sub<Msg>
): (flags: Flags) => Program<Model, Msg>

Added in v0.5.0

model

Dom (type alias)

Dom is a ReactElement.

Signature

export type Dom = ReactElement

Added in v0.5.0

Html (type alias)

Html has Dom type constrained to the specialized version for React.

Signature

export type Html<Msg> = html.Html<Dom, Msg>

Added in v0.5.0

Program (type alias)

Signature

export type Program<Model, Msg> = html.Program<Model, Msg, Dom>

Added in v0.5.0

utils

run

run() is Html.run() with dom type constrained to the specialized version for React.

Signature

export declare function run<Model, Msg>(program: Program<Model, Msg>, renderer: html.Renderer<Dom>): Observable<Model>

Added in v0.5.0