package bonsai

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Start functions

package bonsai

bonsai
- Bonsai
  - Generic
    
    Arrow
    
    Enum
    
    Expert
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    With_incr
  - Make
    
    Applicative_infix
    
    Arrow
    
    Enum
    
    Event
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    With_incr
    
    S
    
    Action
    
    Model
  - S
    
    Applicative_infix
    
    Arrow
    
    Enum
    
    Event
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    With_incr
    
    S
    
    Action
    
    Model
  - S_gen
    
    Applicative_infix
    
    Arrow
    
    Enum
    
    Event
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    With_incr
    
    S
    
    Action
    
    Model
bonsai.mdx
- Bonsai_mdx
  - Bonsai
    
    Applicative_infix
    
    Arrow
    
    Enum
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    With_incr
    
    S
    
    Action
    
    Model
  - Bonsai_web
  - Start
    
    Handle
  - Vdom
    
    Attr
    
    Event
    
    Node
bonsai.types
- Bonsai_types
  - Action
  - Comparator
  - Definition
  - Environment
    
    Key
    
    Packed
  - Model
  - Packed
  - Snapshot
  - Visitor
bonsai.web
- Bonsai_web
  - Bonsai
    
    Applicative_infix
    
    Arrow
    
    Enum
    
    Event
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List_deprecated
    
    M
    
    Component
    
    Action
    
    Input
    
    Model
    
    Result
    
    Map
    
    Proc
    
    Computation
    
    Val
    
    Applicative_infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs_intf
    
    S
    
    Action
    
    Input
    
    Model
    
    Result
    
    With_incr
    
    S
    
    Action
    
    Model
  - Effect
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Start
    
    App_input
    
    App_result
    
    Handle
  - To_incr_dom
    
    S
    
    Action
    
    Model

Legend:
Library
Module
Module type
Parameter
Class
Class type

Start handles the entire lifecycle of web-based Bonsai application.

Put another way, Start is like Core.Command for Bonsai_web apps.

module Handle : sig ... end

module App_input : sig ... end

The input of an application-level component is a value of type ('input, 'outgoing) App_input.t.

module App_result : sig ... end

The result of an application-level component is a value of type 'incoming App_result.t. This value contains the view of the app, and also an inject function: a way for the holder of the Handle.t to send events into the application component.

Start functions

val start_standalone : 
  initial_input:'input ->
  bind_to_element_with_id:string ->
  ('input, Bonsai_web__.Import.Vdom.Node.t) Bonsai_web__.Import.Bonsai.t ->
  ('input, unit, Core_kernel.Nothing.t, Core_kernel.Nothing.t) Handle.t

Start an application, receiving a handle that can't schedule any actions.

The outermost Bonsai.t's result type parameter should be a Vdom.Node.t, which will be bound to the DOM element with id bind_to_element_with_id.

val start : 
  initial_input:'input ->
  bind_to_element_with_id:string ->
  (('input, 'outgoing) App_input.t, ('extra, 'incoming) App_result.t)
    Bonsai_web__.Import.Bonsai.t ->
  ('input, 'extra, 'incoming, 'outgoing) Handle.t

Start an application, receiving a handle that can schedule actions of a user-defined type.

The outermost Bonsai.t's result type parameter should be a pair consisting of:

a Vdom.Node.t, which will be bound to the DOM element with id bind_to_element_with_id; and
an inject function that accepts external actions and returns Vdom.Event.ts.