package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

package virtual_dom

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 Attr := Virtual_dom.Vdom.Attr

module Node := Virtual_dom.Vdom.Node

type node_creator := ?key:string -> ?attr:Attr.t -> Node.t list -> Node.t

val wrap_in_element_if_necessary : Node.t -> Node.Element.t

If node is an Element, do nothing other than returning that Element. Otherwise put a div around the node and return the div's Element.

val add_style : Node.t -> style:Css_gen.t -> Node.t

Change the style attribute of a node. Calls wrap_in_element_if_necessary.

val as_box : 
  [ `Row | `Column ] ->
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator ->
  node_creator

Turn a node_creator into a node_creator that sets the style information on the node to be a flexbox. We also set the flex attribute flex-shrink to 0 if it isn't set (but we leave it alone if it happens to be set).

val as_hbox : 
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator ->
  node_creator

val as_vbox : 
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator ->
  node_creator

val grow : Node.t -> Node.t

Set flex-grow to 1 on the given Node.

val grow_and_shrink : Node.t -> Node.t

Set flex-grow and flex-shrink to 1 on the given Node.

val scrollable : Node.t -> Node.t

Make this a child of a flexbox that can scroll (e.g. if its content is bigger than the size given to it by the parent container, scrollbars will appear)

val hbox : 
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator

Convenience wrapper same as as_hbox Node.div.

val vbox : 
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator

Convenience wrapper same as as_vbox Node.div.

val spacer : 
  ?attrs:Attr.t list ->
  ?min_width:Css_gen.Length.t ->
  ?min_height:Css_gen.Length.t ->
  unit ->
  Node.t

a blank div element

val body : 
  ?direction:[ `Row | `Column ] ->
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator

box (default direction=`Column), width = 100vh, height = 100vh

val modal : 
  ?direction:[ `Row | `Column ] ->
  ?gap:Css_gen.Length.t ->
  ?align_items:Css_gen.item_alignment ->
  node_creator

Display nodes (layouted as a box) in a smaller window on top of everything else (with everything else grayed out and inaccessible via the mouse). Note that this renders a border but no control elements (not even a button to close the window)