package eliom

You can search for identifiers within the package.

in-package search v0.2.0

Advanced client/server Web and mobile framework

Install

dune-project

Dependency

ocsigen.org Readme Edit opam file Versions (33)

Authors

D

dev@ocsigen.org

Maintainers

D

dev@ocsigen.org

Sources

10.4.0.tar.gz

md5=87e171413ab2714514019b533f3f7ab3

sha512=e3ed10c599dd54bc5d4b1bf67debb7068f439d33e30dd39e5ed0cebbddd700b9765a751e16fa93dbd1fa6d934fbb6b2d1677fce817fbfea70565192a0a7e1025

doc/eliom.client/Eliom_content_core/Html/Custom_data/index.html

Module `Html.Custom_data`Source

Type-safe custom data for HTML5. See the <<a_manual chapter="clientserver-html" fragment="custom_data"|examples in the manual>>.

Sourcetype 'a t

Custom data with values of type 'a.

Source

val create : 
  name:string ->
  ?default:'a ->
  to_string:('a -> string) ->
  of_string:(string -> 'a) ->
  unit ->
  'a t

Create a custom data field by providing string conversion functions. If the default is provided, calls to <<a_api project="eliom" subproject="client" | val Eliom_content.Html.Custom_data.get_dom>> return that instead of throwing an exception Not_found.

Sourceval create_json : name:string -> ?default:'a -> 'a Deriving_Json.t -> 'a t

Create a custom data from a Json-deriving type.

Sourceval attrib : 'a t -> 'a -> [> `User_data ] attrib

attrib my_data value creates a HTML5 attribute for the custom-data type my_data with value value for injecting it into an a HTML5 tree ( <<a_api | type Eliom_content.Html.elt >> ).

Sourceval get_dom : Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t -> 'a t -> 'a

get_dom element custom_data gets the custom_data from a JavaScript element ( <<a_api project="js_of_ocaml"|class type Js_of_ocaml.Dom_html.element>> ).

returns
The value encoded in the respective custom data attribute of element, or the default value, if any.

raises Not_found
if the element does not contain the respective custom data attribute and the custom_data was created without default.

Source

val set_dom : 
  Js_of_ocaml.Dom_html.element Js_of_ocaml.Js.t ->
  'a t ->
  'a ->
  unit

set_dom element custom_data value sets the custom data attribute for custom_data of an JavaScript element ( <<a_api project="js_of_ocaml"|class type Js_of_ocaml.Dom_html.element>> ) to value.