Module type Bonsai.S

module Incr : Incremental.S
module Event : Bonsai__.Event.S
include S_gen with module Incr := Incr with module Event := Event with type 'a Proc.Computation.t = ('a, Incr.state_witness, Event.t) Generic.Proc.Computation.t
type on_action_mismatch = [
| `Ignore
| `Raise
| `Warn
]

Default is `Ignore.

type ('input, 'result) t

The component type (('input, 'result) Bonsai.t) can be thought of as a function from 'model to 'result, but where the 'result can schedule events of the component's "action type". These actions are used to produce a new 'model which in turn causes the 'result to be recomputed. Instances of the 'result type can contain callbacks which schedule actions when interacted with by user (via button click, text input, etc). These actions are handled by the component's apply_action function, which yields a new model to be displayed.

val sexp_of_t : (_, _) t -> Core_kernel.Sexp.t
val input : ('input, 'input) t

A bonsai component that just forwards the input straight through to the result. This is equivalent to Bonsai.pure ~f:Fn.id.

Component Constructors

val const : 'result -> (_, 'result) t

Returns a component with no action or model, only a constant result.

val pure : f:('input -> 'result) -> ('input, 'result) t

A pure function with no model from 'input to 'result

val compose : ('i1, 'r1) t -> ('r1, 'r2) t -> ('i1, 'r2) t

compose a b joins a and b together such that the result of a is used as the input of b.

module type S = sig ... end

Many modules have the same shape, they declare the model, action, and result of the component, and then define apply_action and view over those types.

type ('input, 'model, 'action, 'result) component_s = (module S with type Action.t = 'action and type Input.t = 'input and type Model.t = 'model and type Result.t = 'result)
module M : functor (Component : S) -> sig ... end
val of_module : ('input, 'model, 'action, 'result) component_s -> default_model:'model -> ('input, 'result) t
module type Enum = sig ... end
val enum : (module Enum with type t = 'key) -> which:('input -> 'key) -> handle:('key -> ('input, 'result) t) -> ('input, 'result) t
val if_ : ('input -> bool) -> then_:('input, 'result) t -> else_:('input, 'result) t -> ('input, 'result) t

if_ is a simple application of enum to (module Bool).

module Infix : sig ... end

For composing components which share the same model. For example, applying an action in one component changes the shared model, which is reflected in the results of the other component.

include Core_kernel.Applicative.S2 with type ('r, 'i) t := ('i, 'r) t
include Base__.Applicative_intf.For_let_syntax2
type ('a, 'e) t
val return : 'a -> ('a, _) t
val map : ('a, 'e) t -> f:('a -> 'b) -> ('b, 'e) t
val both : ('a, 'e) t -> ('b, 'e) t -> ('a * 'b, 'e) t
include Base__.Applicative_intf.Applicative_infix2 with type ('a, 'e) t := ('a, 'e) t
type ('a, 'e) t
val (<*>) : ('a -> 'b, 'e) t -> ('a, 'e) t -> ('b, 'e) t
val (<*) : ('a, 'e) t -> (unit, 'e) t -> ('a, 'e) t
val (*>) : (unit, 'e) t -> ('a, 'e) t -> ('a, 'e) t
val (>>|) : ('a, 'e) t -> ('a -> 'b) -> ('b, 'e) t
val apply : ('a -> 'b, 'e) t -> ('a, 'e) t -> ('b, 'e) t
val map2 : ('a, 'e) t -> ('b, 'e) t -> f:('a -> 'b -> 'c) -> ('c, 'e) t
val map3 : ('a, 'e) t -> ('b, 'e) t -> ('c, 'e) t -> f:('a -> 'b -> 'c -> 'd) -> ('d, 'e) t
val all : ('a, 'e) t list -> ('a list, 'e) t
val all_unit : (unit, 'e) t list -> (unit, 'e) t
module Applicative_infix : Base__.Applicative_intf.Applicative_infix2 with type ('a, 'e) t := ('a, 'e) t
val map_input : ('i2, 'result) t -> f:('i1 -> 'i2) -> ('i1, 'result) t

Transforms the input of a component. The signature of f is reversed from most other map functions.

module Proc : sig ... end with type 'a Computation.t = ('a, Incr.state_witness, Event.t) Generic.Proc.Computation.t
module Let_syntax : sig ... end

Combinators

val state_machine : (module Bonsai__.Bonsai_intf.Model with type t = 'model) -> (module Bonsai__.Bonsai_intf.Action with type t = 'action) -> Core_kernel.Source_code_position.t -> default_model:'model -> apply_action:(inject:('action -> Event.t) -> schedule_event:(Event.t -> unit) -> 'input -> 'model -> 'action -> 'model) -> ('input, 'model * ('action -> Event.t)) t
module Map : sig ... end
module List_deprecated : sig ... end
module Arrow : sig ... end
module With_incr : sig ... end
val to_generic : ('input, 'result) t -> ('input, 'result, Incr.state_witness, Event.t) Generic.t
val of_generic : ('input, 'result, Incr.state_witness, Event.t) Generic.t -> ('input, 'result) t