package ocaml-vdom

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Rendering "Virtual applications" to concrete ones
1. Extension hooks (command and custom element handlers)
2. Application controller

package ocaml-vdom

ocaml-vdom
- Js_browser
  - ArrayBuffer
  - Blob
  - Canvas
    
    TextMetrics
  - Console
  - DataTransfer
  - Date
  - Document
  - Element
  - Event
  - File
  - FileReader
  - History
  - IFrame
  - JSON
  - JsString
  - Location
  - ObjectURL
  - Performance
  - Promise
  - Rect
  - RegExp
  - SVGRect
  - Storage
  - Style
  - Svg
    
    AnimatedLength
    
    Length
    
    PathElement
    
    PathSeg
    
    PathSegList
  - Uint8Array
  - WebSocket
    
    CloseEvent
  - Window
  - XHR
- Vdom
  - Cmd
  - Custom
- Vdom_blit
  - Cmd
  - Custom

Legend:
Library
Module
Module type
Parameter
Class
Class type

Rendering "Virtual applications" to concrete ones

module Cmd : sig ... end

module Custom : sig ... end

Extension hooks (command and custom element handlers)

type env

val cmd : Cmd.handler -> env

val custom : Custom.handler -> env

val merge : env list -> env

val empty : env

val register : env -> unit

Register global rules (command and custom element handlers). Local ones can also be passed explicitly to run.

Application controller

type ('model, 'msg) app

val run : 
  ?env:env ->
  ?container:Js_browser.Element.t ->
  ('model, 'msg) Vdom.app ->
  ('model, 'msg) app

Instantion a VDOM application into a concrete one, running into a fixed fresh DOM container node.

val dispose : ('model, 'msg) app -> unit

Dispose all the resources attached to an application. If the container was provided on run, it is emptied on disposal, otherwise it is removed from the DOM.

val dom : ('model, 'msg) app -> Js_browser.Element.t

Returns the main DOM node that serves as the container for a Vdom application.

val process : ('model, 'msg) app -> 'msg -> unit

Inject a message into a VDOM application.

val get : ('model, 'msg) app -> 'model

Get the current model of the VDOM application.

val after_redraw : ('model, 'msg) app -> (unit -> unit) -> unit

Execute the callback after the next redraw