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
  - 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 Element : sig ... end

The values associated with an Element and element like nodes. (that is in practice all nodes that aren't just text).

type widget

type t =

| None
| Text of Base.string
| Element of Element.t
| Widget of widget
| Lazy of {
1. key : Base.string Base.option;
2. t : t Base.Lazy.t;
}

module Widget : sig ... end

type node_creator :=
  ?key:Base.string ->
  ?attrs:Virtual_dom__.Attr.t Base.list ->
  t Base.list ->
  t

type node_creator_childless :=
  ?key:Base.string ->
  ?attrs:Virtual_dom__.Attr.t Base.list ->
  Base.unit ->
  t

module Aliases : sig ... end

val none : t

val text : Base.string -> t

val textf : ('a, Base.unit, Base.string, t) Base.format4 -> 'a

val a : node_creator

val abbr : node_creator

val body : node_creator

val button : node_creator

val code : node_creator

val datalist : node_creator

val details : node_creator

val div : node_creator

val main : node_creator

val footer : node_creator

val fieldset : node_creator

val legend : node_creator

val h1 : node_creator

val h2 : node_creator

val h3 : node_creator

val h4 : node_creator

val h5 : node_creator

val h6 : node_creator

val header : node_creator

val html : node_creator

val input : node_creator_childless

val img : node_creator_childless

val textarea : node_creator

val select : node_creator

val optgroup : node_creator

val option : node_creator

val label : node_creator

val li : node_creator

val p : node_creator

val pre : node_creator

val section : node_creator

val span : node_creator

val strong : node_creator

val em : node_creator

val blockquote : node_creator

val summary : node_creator

val iframe : node_creator

val table : node_creator

val tbody : node_creator

val td : node_creator

val th : node_creator

val thead : node_creator

val tr : node_creator

val ul : node_creator

val ol : node_creator

val br : node_creator_childless

val hr : node_creator_childless

val dl : node_creator

val dt : node_creator

val dd : node_creator

val sexp_for_debugging : ?indent:Base.int -> Base.Sexp.t -> t

val lazy_ : ?key:Base.string -> t Base.Lazy.t -> t

val inner_html : 
  ?override_vdom_for_testing:t Base.Lazy.t ->
  tag:Base.string ->
  attrs:Virtual_dom__.Attr.t Base.list ->
  this_html_is_sanitized_and_is_totally_safe_trust_me:Base.string ->
  Base.unit ->
  t

This function can be used to build a node with the tag and html content of that node provided as a string. If this function was called with ~tag:"div" ~attrs:[] ~this_html...:"<b> hello world</b>" then the resulting node would be <div><b> hello world </b></div>

For totally sanitized content strings, this is fine; but if a user can influence the value of content and you don't have a sanitizer, they can inject code into the page, so use with extreme caution!

val inner_html_svg : 
  ?override_vdom_for_testing:t Base.Lazy.t ->
  tag:Base.string ->
  attrs:Virtual_dom__.Attr.t Base.list ->
  this_html_is_sanitized_and_is_totally_safe_trust_me:Base.string ->
  Base.unit ->
  t

Same as inner_html but for svg elements

val input_deprecated : node_creator

Use input instead of input_deprecated. The only difference is that input does not accept a list of child nodes, but input_deprecated does. HTML <input> tags are not meant to have any child elements.

deprecated [since 2022-05] use [input] instead

val create : Base.string -> node_creator

key is used by Virtual_dom as a hint during diffing/patching

val create_svg : Base.string -> node_creator

Like create but for svg nodes (i.e. all to be placed inside <svg> tag). This is needed as browsers maintain separate namespaces for html and svg, and failing to use the correct one may result in delayed redraws.

val to_dom : t -> Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t

Creates a new browser DOM element from a virtual-dom node. Note that calling this function will give you a brand new element, which you then have to put into the DOM yourself. Thus, you should probably not be calling this very often, since Bonsai and Incr_dom both take care calling this function on the top-level view node.

The one situation where to_dom is useful for the typical user is with the Widget API, since building a Widget entails generating the browser DOM element.

val to_raw : t -> Virtual_dom__.Raw.Node.t

val widget : 
  ?vdom_for_testing:t Base.Lazy.t ->
  ?destroy:
    ('s -> Js_of_ocaml.Dom_html.element as 'e Js_of_ocaml.Js.t -> Base.unit) ->
  ?update:('s -> 'e Js_of_ocaml.Js.t -> 's * 'e Js_of_ocaml.Js.t) ->
  id:('s * 'e Js_of_ocaml.Js.t) Base.Type_equal.Id.t ->
  init:(Base.unit -> 's * 'e Js_of_ocaml.Js.t) ->
  Base.unit ->
  t

Creates a Node.t that has fine-grained control over the Browser DOM node.

Callbacks =========

init: Returns a Browser DOM Node and a widget state object. The Browser DOM node is mounted into the dom in the location where the Node.t object would otherwise be.

update: Given the previous Browser DOM Node and state, makes any changes necessary to either and returns a new state and Browser DOM Node.

destroy: Called when this Node.t is removed from the Virtual_dom. Performs any necessary cleanup.

Other =====

The id is used to compare widgets, and is used to make sure that the state from one widget doesn't get interpreted as the state for another. Otherwise, you would be able to implement Obj.magic using this API.

WARNING: While other Virtual_dom APIs shield the application from script injection attacks, the Widget.create function allows a developer to bypass these safeguards and manually create DOM nodes which could allow an attacker to change the behavior of the application or exfiltrate data.

In using this API, you are being trusted to understand and follow security best-practices.

val widget_of_module : 
  (module Widget.S with type Input.t = 'input) ->
  ('input -> t) Base.Staged.t

widget_of_module is very similar to widget, but it pulls all of the callbacks out into a first-class module. Read the comment for widget to learn more.

It is very important that you call widget_of_module exactly once for any "widget class" that you want to construct. Otherwise, the nodes created by it won't be comparable against one another and the widget-diffing will just run destroy, init, destroy, init over and over.

module Patch : sig ... end

module Expert : sig ... end