package js_of_ocaml

  1. Overview
  2. Docs
package js_of_ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

DOM HTML binding

This is a partial binding to the DOM HTML API.

CSS style declaration

class type cssStyleDeclaration = object ... end

Events

type (-'a, -'b) event_listener = ('a, 'b) Dom.event_listener

The type of event listener functions. The first type parameter 'a is the type of the target object; the second parameter 'b is the type of the event object.

type mouse_button =
  1. | No_button
  2. | Left_button
  3. | Middle_button
  4. | Right_button
class type event = object ... end
class type 'a customEvent = object ... end
class type focusEvent = object ... end
class type mouseEvent = object ... end
class type keyboardEvent = object ... end
class type mousewheelEvent = object ... end
class type mouseScrollEvent = object ... end
class type touchEvent = object ... end
class type touchList = object ... end
class type touch = object ... end
class type submitEvent = object ... end
class type dragEvent = object ... end
class type clipboardEvent = object ... end
class type dataTransfer = object ... end
class type eventTarget = object ... end

Common properties of event target objects: onclick, onkeypress, ...

class type popStateEvent = object ... end
class type pointerEvent = object ... end
class type storageEvent = object ... end
class type storage = object ... end

Storage

class type hashChangeEvent = object ... end
class type animationEvent = object ... end
class type mediaEvent = object ... end

HTML elements

class type nodeSelector = object ... end
class type tokenList = object ... end
class type element = object ... end

Properties common to all HTML elements

class type clientRect = object ... end

Rectangular box (used for element bounding boxes)

class type clientRectList = object ... end
class type 'node collection = object ... end

Collection of HTML elements

class type htmlElement = element
class type headElement = object ... end
class type linkElement = object ... end
class type titleElement = object ... end
class type metaElement = object ... end
class type baseElement = object ... end
class type styleElement = object ... end
class type bodyElement = element
class type formElement = object ... end
class type optGroupElement = object ... end
class type optionElement = object ... end
class type selectElement = object ... end
class type inputElement = object ... end
class type textAreaElement = object ... end
class type buttonElement = object ... end
class type labelElement = object ... end
class type fieldSetElement = object ... end
class type legendElement = object ... end
class type uListElement = element
class type oListElement = element
class type dListElement = element
class type liElement = element
class type divElement = element
class type headingElement = element
class type quoteElement = object ... end
class type preElement = element
class type brElement = element
class type hrElement = element
class type modElement = object ... end
class type anchorElement = object ... end
class type imageElement = object ... end
class type objectElement = object ... end
class type paramElement = object ... end
class type areaElement = object ... end
class type mapElement = object ... end
class type scriptElement = object ... end
class type embedElement = object ... end
class type tableCellElement = object ... end
class type tableRowElement = object ... end
class type tableColElement = object ... end
class type tableSectionElement = object ... end
class type tableElement = object ... end
class type timeRanges = object ... end
type networkState =
  1. | NETWORK_EMPTY
  2. | NETWORK_IDLE
  3. | NETWORK_LOADING
  4. | NETWORK_NO_SOURCE
type readyState =
  1. | HAVE_NOTHING
  2. | HAVE_METADATA
  3. | HAVE_CURRENT_DATA
  4. | HAVE_FUTURE_DATA
  5. | HAVE_ENOUGH_DATA
class type mediaElement = object ... end
class type audioElement = object ... end
class type videoElement = object ... end

Canvas object

type context
val _2d_ : context
type canvasPattern
class type canvasElement = object ... end
class type canvasRenderingContext2D = object ... end
class type canvasGradient = object ... end
class type textMetrics = object ... end
class type imageData = object ... end
class type canvasPixelArray = object ... end
val pixel_get : canvasPixelArray Js.t -> int -> int
val pixel_set : canvasPixelArray Js.t -> int -> int -> unit
class type range = object ... end

Object representing a range *

class type selection = object ... end

Information on current selection

Document objects

class type document = object ... end
val document : document Js.t

The current document

val getElementById_opt : string -> element Js.t option

getElementById_opt id returns the element with the id id in the current document. It returns None if there are no such element

val getElementById_exn : string -> element Js.t

getElementById_exn id returns the element with the id id in the current document. It raises if there are no such element

val getElementById_coerce : string -> (element Js.t -> 'a Js.opt) -> 'a option

getElementById_coerce id coerce returns the element with the id id in the current document and attempt to coerce it using the provided coerce function. It returns None if there are no such element or if the coerce function returns Js.none. Typical usage is the following:

match Dom_html.getElementById_coerce "myinput" Dom_html.CoerceTo.input with
| None -> ..
| Some input -> ..
val getElementById : string -> element Js.t

getElementById id returns the element with the id id in the current document. It raises Not_found if there are no such element

Window objects

class type location = object ... end

Location information

val location_origin : location Js.t -> Js.js_string Js.t
class type history = object ... end

Browser history information

class type undoManager = object ... end

Undo manager

class type navigator = object ... end

Navigator information

class type screen = object ... end
class type applicationCache = object ... end
type interval_id
type timeout_id
type animation_frame_request_id
class type _URL = object ... end
class type window = object ... end

Specification of window objects

val window : window Js.t

The current window

class type frameSetElement = object ... end
class type frameElement = object ... end
class type iFrameElement = object ... end

Event handlers

val no_handler : ('a, 'b) event_listener

see Dom.no_handler

val handler : (event Js.t as 'b -> bool Js.t) -> ('a, 'b) event_listener

see Dom.handler

val full_handler : ('a -> event Js.t as 'b -> bool Js.t) -> ('a, 'b) event_listener

see Dom.full_handler

val invoke_handler : ('a, 'b) event_listener -> 'a -> 'b -> bool Js.t

see Dom.invoke_handler

val eventTarget : event Js.t -> element Js.t

see Dom.eventTarget

val eventRelatedTarget : mouseEvent Js.t -> element Js.t Js.opt

Returns this event related target.

module Event : sig ... end

Event types: mousedown, keypress, ...

type event_listener_id = Dom.event_listener_id
val addEventListenerWithOptions : eventTarget Js.t as 'a -> 'b Event.typ -> ?capture:bool Js.t -> ?once:bool Js.t -> ?passive:bool Js.t -> ('a, 'b) event_listener -> event_listener_id

Add an event listener. This function matches the option-object variant of the addEventListener DOM method, except that it returns an id for removing the listener.

val addEventListener : eventTarget Js.t as 'a -> 'b Event.typ -> ('a, 'b) event_listener -> bool Js.t -> event_listener_id

Add an event listener. This function matches the useCapture boolean variant of the addEventListener DOM method, except that it returns an id for removing the listener.

val removeEventListener : event_listener_id -> unit

Remove the given event listener.

val addMousewheelEventListenerWithOptions : eventTarget Js.t as 'a -> ?capture:bool Js.t -> ?once:bool Js.t -> ?passive:bool Js.t -> (mouseEvent Js.t -> dx:int -> dy:int -> bool Js.t) -> event_listener_id

Add a mousewheel event listener with option-object variant of the addEventListener DOM method. The callback is provided the event and the numbers of ticks the mouse wheel moved. Positive means down / right.

val addMousewheelEventListener : eventTarget Js.t as 'a -> (mouseEvent Js.t -> dx:int -> dy:int -> bool Js.t) -> bool Js.t -> event_listener_id

Add a mousewheel event listener with the useCapture boolean variant of the addEventListener DOM method. The callback is provided the event and the numbers of ticks the mouse wheel moved. Positive means down / right.

val createCustomEvent : ?bubbles:bool -> ?cancelable:bool -> ?detail:'a -> 'a customEvent Js.t Event.typ -> 'a customEvent Js.t

See Dom.createCustomEvent

Mouse event helper functions

val buttonPressed : mouseEvent Js.t -> mouse_button

Position helper functions

val eventAbsolutePosition : mouseEvent Js.t -> int * int

Returns the absolute position of the mouse pointer.

val elementClientPosition : element Js.t -> int * int

Position of an element relative to the viewport

val getDocumentScroll : unit -> int * int

Viewport top/left position

Key event helper functions

module Keyboard_code : sig ... end

Use Keyboard_code when you want to identify a key that the user pressed. This should be invoked for keydown and keyup events, not keypress events.

module Keyboard_key : sig ... end

Use Keyboard_key when you want to identify the character that the user typed. This should only be invoked on keypress events, not keydown or keyup events.

Helper functions for creating HTML elements

val createHtml : document Js.t -> htmlElement Js.t
val createHead : document Js.t -> headElement Js.t
val createTitle : document Js.t -> titleElement Js.t
val createMeta : document Js.t -> metaElement Js.t
val createBase : document Js.t -> baseElement Js.t
val createStyle : document Js.t -> styleElement Js.t
val createBody : document Js.t -> bodyElement Js.t
val createForm : document Js.t -> formElement Js.t
val createOptgroup : document Js.t -> optGroupElement Js.t
val createOption : document Js.t -> optionElement Js.t
val createSelect : ?_type:Js.js_string Js.t -> ?name:Js.js_string Js.t -> document Js.t -> selectElement Js.t
val createInput : ?_type:Js.js_string Js.t -> ?name:Js.js_string Js.t -> document Js.t -> inputElement Js.t
val createTextarea : ?_type:Js.js_string Js.t -> ?name:Js.js_string Js.t -> document Js.t -> textAreaElement Js.t
val createButton : ?_type:Js.js_string Js.t -> ?name:Js.js_string Js.t -> document Js.t -> buttonElement Js.t
val createLabel : document Js.t -> labelElement Js.t
val createFieldset : document Js.t -> fieldSetElement Js.t
val createLegend : document Js.t -> legendElement Js.t
val createUl : document Js.t -> uListElement Js.t
val createOl : document Js.t -> oListElement Js.t
val createDl : document Js.t -> dListElement Js.t
val createLi : document Js.t -> liElement Js.t
val createDiv : document Js.t -> divElement Js.t
val createEmbed : document Js.t -> embedElement Js.t
val createH1 : document Js.t -> headingElement Js.t
val createH2 : document Js.t -> headingElement Js.t
val createH3 : document Js.t -> headingElement Js.t
val createH4 : document Js.t -> headingElement Js.t
val createH5 : document Js.t -> headingElement Js.t
val createH6 : document Js.t -> headingElement Js.t
val createQ : document Js.t -> quoteElement Js.t
val createBlockquote : document Js.t -> quoteElement Js.t
val createPre : document Js.t -> preElement Js.t
val createBr : document Js.t -> brElement Js.t
val createHr : document Js.t -> hrElement Js.t
val createIns : document Js.t -> modElement Js.t
val createDel : document Js.t -> modElement Js.t
val createA : document Js.t -> anchorElement Js.t
val createImg : document Js.t -> imageElement Js.t
val createObject : document Js.t -> objectElement Js.t
val createParam : document Js.t -> paramElement Js.t
val createMap : document Js.t -> mapElement Js.t
val createArea : document Js.t -> areaElement Js.t
val createScript : document Js.t -> scriptElement Js.t
val createTable : document Js.t -> tableElement Js.t
val createCaption : document Js.t -> tableCaptionElement Js.t
val createCol : document Js.t -> tableColElement Js.t
val createColgroup : document Js.t -> tableColElement Js.t
val createThead : document Js.t -> tableSectionElement Js.t
val createTfoot : document Js.t -> tableSectionElement Js.t
val createTbody : document Js.t -> tableSectionElement Js.t
val createTr : document Js.t -> tableRowElement Js.t
val createSub : document Js.t -> element Js.t
val createSup : document Js.t -> element Js.t
val createSpan : document Js.t -> element Js.t
val createTt : document Js.t -> element Js.t
val createI : document Js.t -> element Js.t
val createB : document Js.t -> element Js.t
val createBig : document Js.t -> element Js.t
val createSmall : document Js.t -> element Js.t
val createEm : document Js.t -> element Js.t
val createStrong : document Js.t -> element Js.t
val createCite : document Js.t -> element Js.t
val createDfn : document Js.t -> element Js.t
val createCode : document Js.t -> element Js.t
val createSamp : document Js.t -> element Js.t
val createKbd : document Js.t -> element Js.t
val createVar : document Js.t -> element Js.t
val createAbbr : document Js.t -> element Js.t
val createDd : document Js.t -> element Js.t
val createDt : document Js.t -> element Js.t
val createNoscript : document Js.t -> element Js.t
val createAddress : document Js.t -> element Js.t
val createFrameset : document Js.t -> frameSetElement Js.t
val createFrame : document Js.t -> frameElement Js.t
val createIframe : document Js.t -> iFrameElement Js.t
val createAudio : document Js.t -> audioElement Js.t
val createVideo : document Js.t -> videoElement Js.t
exception Canvas_not_available
val createCanvas : document Js.t -> canvasElement Js.t

Coercion functions

val element : Dom.element Js.t -> element Js.t

Coercion from a general DOM element to an HTML element. (Unsafe in general.)

type taggedElement =
  1. | A of anchorElement Js.t
  2. | Area of areaElement Js.t
  3. | Audio of audioElement Js.t
  4. | Base of baseElement Js.t
  5. | Blockquote of quoteElement Js.t
  6. | Body of bodyElement Js.t
  7. | Br of brElement Js.t
  8. | Button of buttonElement Js.t
  9. | Canvas of canvasElement Js.t
  10. | Caption of tableCaptionElement Js.t
  11. | Col of tableColElement Js.t
  12. | Colgroup of tableColElement Js.t
  13. | Del of modElement Js.t
  14. | Div of divElement Js.t
  15. | Dl of dListElement Js.t
  16. | Embed of embedElement Js.t
  17. | Fieldset of fieldSetElement Js.t
  18. | Form of formElement Js.t
  19. | Frameset of frameSetElement Js.t
  20. | Frame of frameElement Js.t
  21. | H1 of headingElement Js.t
  22. | H2 of headingElement Js.t
  23. | H3 of headingElement Js.t
  24. | H4 of headingElement Js.t
  25. | H5 of headingElement Js.t
  26. | H6 of headingElement Js.t
  27. | Head of headElement Js.t
  28. | Hr of hrElement Js.t
  29. | Html of htmlElement Js.t
  30. | Iframe of iFrameElement Js.t
  31. | Img of imageElement Js.t
  32. | Input of inputElement Js.t
  33. | Ins of modElement Js.t
  34. | Label of labelElement Js.t
  35. | Legend of legendElement Js.t
  36. | Li of liElement Js.t
  37. | Map of mapElement Js.t
  38. | Meta of metaElement Js.t
  39. | Object of objectElement Js.t
  40. | Ol of oListElement Js.t
  41. | Optgroup of optGroupElement Js.t
  42. | Option of optionElement Js.t
  43. | P of paramElement Js.t
  44. | Param of paramElement Js.t
  45. | Pre of preElement Js.t
  46. | Q of quoteElement Js.t
  47. | Script of scriptElement Js.t
  48. | Select of selectElement Js.t
  49. | Style of styleElement Js.t
  50. | Table of tableElement Js.t
  51. | Tbody of tableSectionElement Js.t
  52. | Td of tableCellElement Js.t
  53. | Textarea of textAreaElement Js.t
  54. | Tfoot of tableSectionElement Js.t
  55. | Th of tableCellElement Js.t
  56. | Thead of tableSectionElement Js.t
  57. | Title of titleElement Js.t
  58. | Tr of tableRowElement Js.t
  59. | Ul of uListElement Js.t
  60. | Video of videoElement Js.t
  61. | Other of element Js.t
val tagged : element Js.t -> taggedElement
val opt_tagged : element Js.t Js.opt -> taggedElement option
type taggedEvent =
  1. | MouseEvent of mouseEvent Js.t
  2. | KeyboardEvent of keyboardEvent Js.t
  3. | MousewheelEvent of mousewheelEvent Js.t
  4. | MouseScrollEvent of mouseScrollEvent Js.t
  5. | PopStateEvent of popStateEvent Js.t
  6. | OtherEvent of event Js.t
val taggedEvent : event Js.t -> taggedEvent
val opt_taggedEvent : event Js.t Js.opt -> taggedEvent option
val stopPropagation : event Js.t -> unit
module CoerceTo : sig ... end

HTMLElement

type timeout_id_safe
val setTimeout : (unit -> unit) -> float -> timeout_id_safe

Same as Dom_html.window##setTimeout cb ms but prevents overflow with delay greater than 24 days.

val clearTimeout : timeout_id_safe -> unit
val js_array_of_collection : element collection Js.t -> element Js.t Js.js_array Js.t

Convert a Dom_html.collection to a Js array

Deprecated function.

val _requestAnimationFrame : (unit -> unit) Js.callback -> unit

Call the appropriate requestAnimationFrame method variant (depending on the navigator), or sleep for a short amount of time when there no such method is provided. We currently prefix the function name with as underscore as the interface of this function is not completely standardized yet. Thus, we leave the room to a function with a possibly refined type.

This function is deprecated. Use the requestAnimationFrame of the window object instead.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct