package virtual_dom

You can search for identifiers within the package.

in-package search v0.2.0

package virtual_dom

virtual_dom
- LICENSE
- Library virtual_dom
  - Virtual_dom
    
    Vdom
    
    Attr
    
    Expert
    
    Attrs
    
    Event
    
    Handler
    
    Action
    
    Visibility_handler
    
    S
    
    Define
    
    Define_visibility
    
    Expert
    
    Node
    
    Element
    
    Widget
    
    Patch
    
    Tyxml
    
    XML
    
    W
    
    Xml
    
    W
    
    Svg
    
    Xml
    
    W
    
    Info
    
    Unsafe
    
    Html
    
    Xml
    
    W
    
    Info
    
    Unsafe
    
    Dom_float
- Library virtual_dom.css_gen
  - Css_gen
    
    Color
    
    RGBA
    
    HSLA
    
    Length
    
    Auto_or_length
    
    Stable
    
    V1
- Library virtual_dom.svg
  - Virtual_dom_svg
    
    Attr
    
    Text
    
    Node
- Library virtual_dom.ui_event
  - Ui_event
    
    Handler
    
    Action
    
    S
    
    Define
    
    Expert
- Library virtual_dom.vdom_test_helpers
  - Virtual_dom_test_helpers
    
    Handler
    
    Node_helpers
    
    User_actions
- Sources
  - virtual_dom
    
    attr.ml
    
    attr_intf.ml
    
    attrs.ml
    
    dom_float.ml
    
    event.ml
    
    event_intf.ml
    
    node.ml
    
    tyxml.ml
    
    tyxml_f.ml
    
    vdom.ml
    
    virtual_dom.ml
    
    virtual_dom__.ml
  - virtual_dom.css_gen
    
    css_gen.ml
    
    css_gen__.ml
    
    css_parser.ml
    
    css_tokenizer.ml
  - virtual_dom.svg
    
    attr.ml
    
    node.ml
    
    virtual_dom_svg.ml
  - virtual_dom.ui_event
    
    ui_event.ml
    
    ui_event__.ml
    
    ui_event_intf.ml
  - virtual_dom.vdom_test_helpers
    
    handler.ml
    
    node_helpers.ml
    
    virtual_dom_test_helpers.ml
    
    virtual_dom_test_helpers__.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Vdom.Node`Source

Sourcemodule Element : sig ... end

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

Sourcemodule Widget : Base.T

Sourcetype t =

| None
| Text of Base.string
| Element of Element.t
| Widget of Widget.t

Source

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

Source

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

Sourceval none : t

Sourceval text : Base.string -> t

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

Sourceval a : node_creator

Sourceval body : node_creator

Sourceval button : node_creator

Sourceval code : node_creator

Sourceval div : node_creator

Sourceval footer : node_creator

Sourceval h1 : node_creator

Sourceval h2 : node_creator

Sourceval h3 : node_creator

Sourceval h4 : node_creator

Sourceval h5 : node_creator

Sourceval h6 : node_creator

Sourceval header : node_creator

Sourceval html : node_creator

Sourceval input : node_creator

Sourceval textarea : node_creator

Sourceval select : node_creator

Sourceval option : node_creator

Sourceval label : node_creator

Sourceval li : node_creator

Sourceval p : node_creator

Sourceval pre : node_creator

Sourceval section : node_creator

Sourceval span : node_creator

Sourceval strong : node_creator

Sourceval table : node_creator

Sourceval tbody : node_creator

Sourceval td : node_creator

Sourceval th : node_creator

Sourceval thead : node_creator

Sourceval tr : node_creator

Sourceval ul : node_creator

Sourceval ol : node_creator

Sourceval br : node_creator_childless

Sourceval hr : node_creator_childless

Source

val create : 
  Base.string ->
  ?key:Base.string ->
  Virtual_dom__.Attr.t Base.list ->
  t Base.list ->
  t

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

Source

val create_svg : 
  Base.string ->
  ?key:Base.string ->
  Virtual_dom__.Attr.t Base.list ->
  t Base.list ->
  t

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.

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

Sourceval unsafe_to_js : t -> Js_of_ocaml.Js.Unsafe.any

Source

val widget : 
  ?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.

Sourcemodule Patch : sig ... end

package virtual_dom

Module Vdom.NodeSource

Module `Vdom.Node`Source