package js_of_ocaml
DOM binding
This is a partial binding to the DOM Core API.
DOM objects
class type 'node nodeList = object ... end
Specification of NodeList
objects.
module DocumentPosition : sig ... end
class type node = object ... end
Specification of Node
objects.
class type attr = object ... end
Specification of Attr
objects.
class type 'node namedNodeMap = object ... end
Specification of NamedNodeMap
objects.
class type element = object ... end
Specification of Element
objects.
class type characterData = object ... end
Specification of CharacterData
objects.
class type comment = characterData
Specification of Comment
objects
class type text = characterData
Specification of Text
objects.
class type documentFragment = node
Specification of DocumentFragment
objects.
class type 'element document = object ... end
Specification of Document
objects.
Helper functions
insertBefore p n c
inserts node n
as child of node p
, just before node c
, or as last child if p
is empty. The expression insertBefore n c p
behave the same as p##insertBefore n c
but avoid the need of coercing the different objects to node t
.
The expression replaceChild p n c
behave the same as p##replaceChild n c
(replace c
by n
in p
) but avoid the need of coercing the different objects to node t
.
The expression removeChild n c
behave the same as n##removeChild c
(remove c
from n
) but avoid the need of coercing the different objects to node t
.
The expression appendChild n c
behave the same as n##appendChild c
(appends c
to n
) but avoid the need of coercing the different objects to node t
.
module CoerceTo : sig ... end
Events
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.
class type 'a event = object ... end
Event handlers
val no_handler : ('a, 'b) event_listener
Void event handler (Javascript null
value).
val handler : ('e event Js.t as 'b -> bool Js.t) -> ('a, 'b) event_listener
Create an event handler that invokes the provided function. If the handler returns false, the default action is prevented.
val full_handler :
('a -> 'e event Js.t as 'b -> bool Js.t) ->
('a, 'b) event_listener
Create an event handler that invokes the provided function. The event target (implicit parameter this
) is also passed as argument to the function.
val invoke_handler : ('a, 'b) event_listener -> 'a -> 'b -> bool Js.t
Invoke an existing handler. Useful to chain event handlers.
Returns which object is the target of this event. It raises Not_found
in case there is no target (if the event has not been triggered yet)
module Event : sig ... end
val addEventListener :
< .. > 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 addEventListener
DOM method, except that it returns an id for removing the listener.
val removeEventListener : event_listener_id -> unit
Remove the given event listener.
Call this to prevent the default handler for the event. To stop propagation of the event, call Dom_html.stopPropagation
.
Other DOM objects
class type stringList = object ... end