package eliom

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

Node identifiers

type +'a id

The type of global HTML5 element identifier.

val new_elt_id : ?global:bool -> unit -> 'a id

The function new_elt_id () creates a new global HTML5 element identifier (see the Eliom manual for more information on <<a_manual project="eliom" chapter="clientserver-html" fragment="global"|global element>>).

val create_named_elt : id:'a id -> 'a elt -> 'a elt

The function create_named_elt ~id elt create a copy of the element elt that will be sent to client with the reference id.

val create_global_elt : 'a elt -> 'a elt

The function create_named_elt elt is equivalent to create_named_elt ~id:(new_elt_id ()) elt.

val create_request_elt : ?reset:bool -> 'a elt -> 'a elt

create_request_elt ?reset elt creates a referable copy of elt. If ~reset = true is provided (default: false), a new ID is created even if elt has an ID already.

val get_element : 'a id -> 'a elt option

get_element id returns the HTML element in the DOM with the given id if it exists.

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