package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

virtual_dom
- Virtual_dom
  - Dom_float
  - Js_map
  - Top_level_effects
  - Vdom
    
    Attr
    
    Always_focus_hook
    
    Expert
    
    Global_listeners
    
    For_testing
    
    Hooks
    
    For_testing
    
    Extra
    
    Input
    
    Make
    
    For_testing
    
    S
    
    Input
    
    S
    
    Input
    
    Multi
    
    No_op_hook
    
    M
    
    Input
    
    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.html5_history
- Html5_history
virtual_dom.input_widgets
- Vdom_input_widgets
  - Button
  - Checkbox
  - Checklist
  - Display
  - Dropdown
  - Entry
    
    Call_on_input_when
  - Enum
  - Enum_set
  - Equal
  - File_select
  - Merge_behavior
  - Multi_select
    
    Repeated_click_behavior
  - Radio_buttons
  - Selectable_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
    
    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
    
    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
  - Html
    
    Info
    
    Unsafe
    
    Xml
  - Svg
    
    Info
    
    Unsafe
    
    Xml
  - XML
    
    W
  - Xml
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 State : Core.T

module Input : sig ... end

val init : Input.t -> Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t -> State.t

init is called the first time that this attribute is attached to a particular node. It is particularly responsible for producing a value of type State.t. The element that it is being attached to is not necessarily attached to the rest of the DOM tree.

val on_mount : 
  Input.t ->
  State.t ->
  Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t ->
  unit

on_mount is called once, after the element is attached to the rest of the DOM tree.

val update : 
  old_input:Input.t ->
  new_input:Input.t ->
  State.t ->
  Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t ->
  unit

update is called when a previous attribute of the same kind existed on the vdom node. You get access to the Input.t that the previous node was created with, as well as the State.t for that hook, which you can mutate if you like. There is no guarantee that update will be called instead of a sequence of destroy followed by init, so update should behave the same as that sequence (except it might be faster).

val destroy : 
  Input.t ->
  State.t ->
  Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t ->
  unit

destroy is called when the previous vdom has this hook, but a newer vdom tree does not. The last input and state are passed in alongside the element that it used to be attached to.