package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

virtual_dom
- Virtual_dom
  - Dom_float
  - Top_level_effects
  - Vdom
    
    Attr
    
    Always_focus_hook
    
    Expert
    
    Global_listeners
    
    For_testing
    
    Hooks
    
    For_testing
    
    Extra
    
    Make
    
    For_testing
    
    S
    
    Input
    
    State
    
    S
    
    Input
    
    State
    
    Multi
    
    Single_focus_hook
    
    Unmerged_warning_mode
    
    For_testing
    
    Effect
    
    Define_visibility
    
    VH
    
    Expert
    
    S
    
    Visibility_handler
    
    Node
    
    Aliases
    
    Element
    
    Expert
    
    Patch
    
    Widget
    
    S
    
    Input
    
    State
virtual_dom.css_gen
- Css_gen
  - Auto_or_length
  - Color
    
    HSLA
    
    RGBA
  - Expert
  - Length
  - Private
  - Stable
    
    V1
virtual_dom.input_widgets
- Vdom_input_widgets
  - Button
  - Checkbox
  - Checklist
  - Display
  - Dropdown
  - Entry
    
    Call_on_input_when
  - Enum
  - Enum_set
  - Equal
  - File_select
  - Multi_select
    
    Repeated_click_behavior
  - Radio_buttons
    
    Style
  - Set
  - Validated
virtual_dom.keyboard
- Vdom_keyboard
  - Grouped_help_text
    
    Group_name
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Elt
    
    Named
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    View_spec
  - Help_text
    
    Command
    
    Format
    
    View_spec
  - Keyboard_event
  - Keyboard_event_handler
    
    Action
    
    Variants
    
    Command
    
    Condition
    
    Handler
  - Keystroke
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Keyboard_code
    
    Map
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Set
    
    Elt
    
    Named
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Variable_keyboard_event_handler
    
    Variable_handler_action
    
    Variable_handler_command
virtual_dom.layout
- Vdom_layout
virtual_dom.svg
- Virtual_dom_svg
  - Attr
    
    Text
  - Node
virtual_dom.tyxml
- Virtual_dom_tyxml
virtual_dom.ui_effect
- Ui_effect
  - Define
    
    Handler
    
    Action
  - Define1
    
    Handler
    
    Action
  - Expert
  - For_testing
    
    Query_response_tracker
    
    Svar
  - Handler
    
    Action
  - Let_syntax
    
    Let_syntax
    
    Open_on_rhs
  - Monad_infix
  - Private
    
    Callback
  - S
virtual_dom.vdom_test_helpers
- Virtual_dom_test_helpers
  - Handler
  - Node_helpers
    
    User_actions

Legend:
Library
Module
Module type
Parameter
Class
Class type

module type Handler = sig ... end

module type S = sig ... end

type 'a t = ..

'a Effect.t represents some computation of type 'a that can be performed outside of the typical computational/incremental structure of a Bonsai program . Examples of this computation might be:

Calling an RPC and getting the result back
Running expensive computation on a web-worker thread
Requesting some information from the imperative "Start.Handle"-holding code

If you have a value of type 'a Effect.t, you can schedule it to be run by calling inject and providing a function that will be called when the callback completes.

type t +=

| Ignore : unit t
| Many : unit t list -> unit t

include Core.Monad.S with type 'a t := 'a t

val (>>=) : 'a t -> ('a -> 'b t) -> 'b t

val (>>|) : 'a t -> ('a -> 'b) -> 'b t

module Monad_infix : sig ... end

val bind : 'a t -> f:('a -> 'b t) -> 'b t

val return : 'a -> 'a t

val map : 'a t -> f:('a -> 'b) -> 'b t

val join : 'a t t -> 'a t

val ignore_m : 'a t -> unit t

val all : 'a t list -> 'a list t

val all_unit : unit t list -> unit t

module Let_syntax : sig ... end

val never : 'a t

An effect that never completes

val lazy_ : 'a t Core.Lazy.t -> 'a t

If creating an effect could be expensive, you can wrap its construction in a lazy and pass it to this function so that its construction will be deferred until it's about to be evaluated.

val print_s : Core.Sexp.t -> unit t

Prints the sexp when scheduled.

val of_sync_fun : ('query -> 'result) -> 'query -> 'result t

of_sync_fun is similar to of_deferred_fun but with a synchronous function instead of a deferred one. This can be used for functions that are synchronous but side-effecting, or as a mock-function in tests that replace the usages of of_deferred_fun in the actual app.

Note that, unlike of_deferred_fun, the function must return immediately, so it's not possible to test the behaviour of tour app between calling the function and the effect becoming 'determined'. If you need to do this, see of_svar and of_query_response_tracker below.

module Define
  (Handler : Handler) : 
  S with type action := Handler.Action.t and type 'a t := 'a t

module Define1 (Handler : sig ... end) : sig ... end

module Expert : sig ... end

module Private : sig ... end

module For_testing : sig ... end