package bonsai

  1. Overview
  2. Docs
A library for building dynamic webapps, using Js_of_ocaml

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=c78c4476ee6b856846e2d0941e5965009d5e1b853e564b2b1bee61202f0b1ebb

doc/bonsai.driver/Bonsai_driver/index.html

Module Bonsai_driverSource

Sourcemodule Incr = Ui_incr
Sourcetype 'r t
Sourceval create : ?optimize:bool -> clock:Bonsai.Time_source.t -> 'r Bonsai.Computation.t -> 'r t

Builds a new driver for a bonsai component.

The "main loop" of a bonsai handle is 1. flush - dequeue events and process actions 2. result - compute the final value of the computation 3. trigger_lifecycles - run any lifecycle events for this stabilization

Sourceval flush : _ t -> unit

Apply all pending actions and stabilize the incremental graph, updating result.

Sourceval result : 'r t -> 'r

retreives the computed result of the bonsai application

Sourceval trigger_lifecycles : _ t -> unit

Triggers all lifecycle events that need to be run. Lifecycle events are run in this order: 1. componnet deactivations 2. component activations 3. after display, which includes things like on_change

Sourceval schedule_event : _ t -> unit Ui_effect.t -> unit

Schedules an event

Sourceval has_after_display_events : _ t -> bool

returns true if the lifecycle collection has anything that it wants to do after the display is processed.

Sourcemodule Expert : sig ... end
Sourcemodule For_testing : sig ... end