package eliom

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

Typed interface for building valid HTML5 tree (DOM semantics). See <<a_api project="tyxml" | module type Html_sigs.T >> .

module Raw : sig ... end
type 'a elt = 'a elt
type doc = Html_types.html elt
type 'a attrib = 'a attrib
module Xml : sig ... end
type 'a wrap = 'a Xml.W.t
type 'a list_wrap = 'a Xml.W.tlist
type ('a, 'b) nullary = ?a:'a attrib list -> unit -> 'b elt
type ('a, 'b, 'c) unary = ?a:'a attrib list -> 'b elt wrap -> 'c elt
type ('a, 'b, 'c) star = ?a:'a attrib list -> 'b elt list_wrap -> 'c elt
type uri = Xml.uri
val string_of_uri : (uri, string) Xml.W.ft
val uri_of_string : (string, uri) Xml.W.ft
val a_class : Html_types.nmtokens wrap -> [> `Class ] attrib
val a_user_data : Html_types.nmtoken -> Html_types.text wrap -> [> `User_data ] attrib
val a_id : Html_types.text wrap -> [> `Id ] attrib
val a_title : Html_types.text wrap -> [> `Title ] attrib
val a_xml_lang : Html_types.languagecode wrap -> [> `XML_lang ] attrib
val a_lang : Html_types.languagecode wrap -> [> `Lang ] attrib
val a_onabort : Xml.event_handler -> [> `OnAbort ] attrib
val a_onafterprint : Xml.event_handler -> [> `OnAfterPrint ] attrib
val a_onbeforeprint : Xml.event_handler -> [> `OnBeforePrint ] attrib
val a_onbeforeunload : Xml.event_handler -> [> `OnBeforeUnload ] attrib
val a_onblur : Xml.event_handler -> [> `OnBlur ] attrib
val a_oncanplay : Xml.event_handler -> [> `OnCanPlay ] attrib
val a_oncanplaythrough : Xml.event_handler -> [> `OnCanPlayThrough ] attrib
val a_onchange : Xml.event_handler -> [> `OnChange ] attrib
val a_onclose : Xml.event_handler -> [> `OnClose ] attrib
val a_ondurationchange : Xml.event_handler -> [> `OnDurationChange ] attrib
val a_onemptied : Xml.event_handler -> [> `OnEmptied ] attrib
val a_onended : Xml.event_handler -> [> `OnEnded ] attrib
val a_onerror : Xml.event_handler -> [> `OnError ] attrib
val a_onfocus : Xml.event_handler -> [> `OnFocus ] attrib
val a_onformchange : Xml.event_handler -> [> `OnFormChange ] attrib
val a_onforminput : Xml.event_handler -> [> `OnFormInput ] attrib
val a_onhashchange : Xml.event_handler -> [> `OnHashChange ] attrib
val a_oninput : Xml.event_handler -> [> `OnInput ] attrib
val a_oninvalid : Xml.event_handler -> [> `OnInvalid ] attrib
val a_onmousewheel : Xml.event_handler -> [> `OnMouseWheel ] attrib
val a_onoffline : Xml.event_handler -> [> `OnOffLine ] attrib
val a_ononline : Xml.event_handler -> [> `OnOnLine ] attrib
val a_onpause : Xml.event_handler -> [> `OnPause ] attrib
val a_onplay : Xml.event_handler -> [> `OnPlay ] attrib
val a_onplaying : Xml.event_handler -> [> `OnPlaying ] attrib
val a_onpagehide : Xml.event_handler -> [> `OnPageHide ] attrib
val a_onpageshow : Xml.event_handler -> [> `OnPageShow ] attrib
val a_onpopstate : Xml.event_handler -> [> `OnPopState ] attrib
val a_onprogress : Xml.event_handler -> [> `OnProgress ] attrib
val a_onratechange : Xml.event_handler -> [> `OnRateChange ] attrib
val a_onreadystatechange : Xml.event_handler -> [> `OnReadyStateChange ] attrib
val a_onredo : Xml.event_handler -> [> `OnRedo ] attrib
val a_onresize : Xml.event_handler -> [> `OnResize ] attrib
val a_onscroll : Xml.event_handler -> [> `OnScroll ] attrib
val a_onseeked : Xml.event_handler -> [> `OnSeeked ] attrib
val a_onseeking : Xml.event_handler -> [> `OnSeeking ] attrib
val a_onselect : Xml.event_handler -> [> `OnSelect ] attrib
val a_onshow : Xml.event_handler -> [> `OnShow ] attrib
val a_onstalled : Xml.event_handler -> [> `OnStalled ] attrib
val a_onstorage : Xml.event_handler -> [> `OnStorage ] attrib
val a_onsubmit : Xml.event_handler -> [> `OnSubmit ] attrib
val a_onsuspend : Xml.event_handler -> [> `OnSuspend ] attrib
val a_ontimeupdate : Xml.event_handler -> [> `OnTimeUpdate ] attrib
val a_onundo : Xml.event_handler -> [> `OnUndo ] attrib
val a_onunload : Xml.event_handler -> [> `OnUnload ] attrib
val a_onvolumechange : Xml.event_handler -> [> `OnVolumeChange ] attrib
val a_onwaiting : Xml.event_handler -> [> `OnWaiting ] attrib
val a_onload : Xml.event_handler -> [> `OnLoad ] attrib
val a_onloadeddata : Xml.event_handler -> [> `OnLoadedData ] attrib
val a_onloadedmetadata : Xml.event_handler -> [> `OnLoadedMetaData ] attrib
val a_onloadstart : Xml.event_handler -> [> `OnLoadStart ] attrib
val a_onmessage : Xml.event_handler -> [> `OnMessage ] attrib
val a_onclick : Xml.mouse_event_handler -> [> `OnClick ] attrib
val a_oncontextmenu : Xml.mouse_event_handler -> [> `OnContextMenu ] attrib
val a_ondblclick : Xml.mouse_event_handler -> [> `OnDblClick ] attrib
val a_ondrag : Xml.mouse_event_handler -> [> `OnDrag ] attrib
val a_ondragend : Xml.mouse_event_handler -> [> `OnDragEnd ] attrib
val a_ondragenter : Xml.mouse_event_handler -> [> `OnDragEnter ] attrib
val a_ondragleave : Xml.mouse_event_handler -> [> `OnDragLeave ] attrib
val a_ondragover : Xml.mouse_event_handler -> [> `OnDragOver ] attrib
val a_ondragstart : Xml.mouse_event_handler -> [> `OnDragStart ] attrib
val a_ondrop : Xml.mouse_event_handler -> [> `OnDrop ] attrib
val a_onmousedown : Xml.mouse_event_handler -> [> `OnMouseDown ] attrib
val a_onmouseup : Xml.mouse_event_handler -> [> `OnMouseUp ] attrib
val a_onmouseover : Xml.mouse_event_handler -> [> `OnMouseOver ] attrib
val a_onmousemove : Xml.mouse_event_handler -> [> `OnMouseMove ] attrib
val a_onmouseout : Xml.mouse_event_handler -> [> `OnMouseOut ] attrib
val a_ontouchstart : Xml.touch_event_handler -> [> `OnTouchStart ] attrib
val a_ontouchend : Xml.touch_event_handler -> [> `OnTouchEnd ] attrib
val a_ontouchmove : Xml.touch_event_handler -> [> `OnTouchMove ] attrib
val a_ontouchcancel : Xml.touch_event_handler -> [> `OnTouchCancel ] attrib
val a_onkeypress : Xml.keyboard_event_handler -> [> `OnKeyPress ] attrib
val a_onkeydown : Xml.keyboard_event_handler -> [> `OnKeyDown ] attrib
val a_onkeyup : Xml.keyboard_event_handler -> [> `OnKeyUp ] attrib
val a_allowfullscreen : unit -> [> `Allowfullscreen ] attrib
val a_allowpaymentrequest : unit -> [> `Allowpaymentrequest ] attrib
val a_autocomplete : Html_types.autocomplete_option wrap -> [> `Autocomplete ] attrib
val a_async : unit -> [> `Async ] attrib
val a_autofocus : unit -> [> `Autofocus ] attrib
val a_autoplay : unit -> [> `Autoplay ] attrib
val a_muted : unit -> [> `Muted ] attrib
val a_crossorigin : [< `Anonymous | `Use_credentials ] wrap -> [> `Crossorigin ] attrib
val a_integrity : string wrap -> [> `Integrity ] attrib
val a_mediagroup : string wrap -> [> `Mediagroup ] attrib
val a_challenge : Html_types.text wrap -> [> `Challenge ] attrib
val a_contenteditable : bool wrap -> [> `Contenteditable ] attrib
val a_contextmenu : Html_types.idref wrap -> [> `Contextmenu ] attrib
val a_controls : unit -> [> `Controls ] attrib
val a_dir : [< `Ltr | `Rtl ] wrap -> [> `Dir ] attrib
val a_draggable : bool wrap -> [> `Draggable ] attrib
val a_form : Html_types.idref wrap -> [> `Form ] attrib
val a_formaction : Xml.uri wrap -> [> `Formaction ] attrib
val a_formenctype : Html_types.contenttype wrap -> [> `Formenctype ] attrib
val a_formnovalidate : unit -> [> `Formnovalidate ] attrib
val a_formtarget : Html_types.text wrap -> [> `Formtarget ] attrib
val a_hidden : unit -> [> `Hidden ] attrib
val a_high : Html_types.float_number wrap -> [> `High ] attrib
val a_icon : Xml.uri wrap -> [> `Icon ] attrib
val a_ismap : unit -> [> `Ismap ] attrib
val a_keytype : Html_types.text wrap -> [> `Keytype ] attrib
val a_list : Html_types.idref wrap -> [> `List ] attrib
val a_loop : unit -> [> `Loop ] attrib
val a_low : Html_types.float_number wrap -> [> `High ] attrib
val a_max : Html_types.float_number wrap -> [> `Max ] attrib
val a_input_max : Html_types.number_or_datetime wrap -> [> `Input_Max ] attrib
val a_min : Html_types.float_number wrap -> [> `Min ] attrib
val a_input_min : Html_types.number_or_datetime wrap -> [> `Input_Min ] attrib
val a_inputmode : [< `Decimal | `Email | `None | `Numeric | `Search | `Tel | `Text | `Url ] wrap -> [> `Inputmode ] attrib
val a_novalidate : unit -> [> `Novalidate ] attrib
val a_open : unit -> [> `Open ] attrib
val a_optimum : Html_types.float_number wrap -> [> `Optimum ] attrib
val a_pattern : Html_types.text wrap -> [> `Pattern ] attrib
val a_placeholder : Html_types.text wrap -> [> `Placeholder ] attrib
val a_poster : Xml.uri wrap -> [> `Poster ] attrib
val a_preload : [< `Audio | `Metadata | `None ] wrap -> [> `Preload ] attrib
val a_pubdate : unit -> [> `Pubdate ] attrib
val a_radiogroup : Html_types.text wrap -> [> `Radiogroup ] attrib
val a_referrerpolicy : Html_types.referrerpolicy wrap -> [> `Referrerpolicy ] attrib
val a_required : unit -> [> `Required ] attrib
val a_reversed : unit -> [> `Reversed ] attrib
val a_sandbox : [< Html_types.sandbox_token ] list wrap -> [> `Sandbox ] attrib
val a_spellcheck : bool wrap -> [> `Spellcheck ] attrib
val a_scoped : unit -> [> `Scoped ] attrib
val a_seamless : unit -> [> `Seamless ] attrib
val a_sizes : (Html_types.number * Html_types.number) list option wrap -> [> `Sizes ] attrib
val a_span : Html_types.number wrap -> [> `Span ] attrib
val a_srclang : Html_types.nmtoken wrap -> [> `XML_lang ] attrib
  • deprecated Use a_xml_lang instead.
type image_candidate = [
  1. | `Url of uri
  2. | `Url_pixel of uri * Html_types.float_number
  3. | `Url_width of uri * Html_types.number
]
val a_srcset : image_candidate list wrap -> [> `Srcset ] attrib
val a_img_sizes : Html_types.text list wrap -> [> `Img_sizes ] attrib
val a_start : Html_types.number wrap -> [> `Start ] attrib
val a_step : Html_types.float_number option wrap -> [> `Step ] attrib
val a_translate : [< `No | `Yes ] wrap -> [> `Translate ] attrib
val a_wrap : [< `Hard | `Soft ] wrap -> [> `Wrap ] attrib
val a_version : Html_types.cdata wrap -> [> `Version ] attrib
val a_xmlns : [< `W3_org_1999_xhtml ] wrap -> [> `XMLns ] attrib
val a_manifest : Xml.uri wrap -> [> `Manifest ] attrib
val a_cite : Xml.uri wrap -> [> `Cite ] attrib
val a_xml_space : [< `Default | `Preserve ] wrap -> [> `XML_space ] attrib
val a_accesskey : Html_types.character wrap -> [> `Accesskey ] attrib
val a_charset : Html_types.charset wrap -> [> `Charset ] attrib
val a_accept_charset : Html_types.charsets wrap -> [> `Accept_charset ] attrib
val a_accept : Html_types.contenttypes wrap -> [> `Accept ] attrib
val a_href : Xml.uri wrap -> [> `Href ] attrib
val a_hreflang : Html_types.languagecode wrap -> [> `Hreflang ] attrib
val a_download : string option wrap -> [> `Download ] attrib
val a_rel : Html_types.linktypes wrap -> [> `Rel ] attrib
val a_tabindex : Html_types.number wrap -> [> `Tabindex ] attrib
val a_mime_type : Html_types.contenttype wrap -> [> `Mime_type ] attrib
val a_datetime : Html_types.cdata wrap -> [> `Datetime ] attrib
val a_action : Xml.uri wrap -> [> `Action ] attrib
val a_checked : unit -> [> `Checked ] attrib
val a_cols : Html_types.number wrap -> [> `Cols ] attrib
val a_enctype : Html_types.contenttype wrap -> [> `Enctype ] attrib
val a_label_for : Html_types.idref wrap -> [> `Label_for ] attrib
val a_for : Html_types.idref wrap -> [> `Label_for ] attrib
  • deprecated Use a_label_for
val a_output_for : Html_types.idrefs wrap -> [> `Output_for ] attrib
val a_for_list : Html_types.idrefs wrap -> [> `Output_for ] attrib
  • deprecated Use a_output_for
val a_maxlength : Html_types.number wrap -> [> `Maxlength ] attrib
val a_minlength : Html_types.number wrap -> [> `Minlength ] attrib
val a_method : [< `Get | `Post ] wrap -> [> `Method ] attrib
val a_formmethod : [< `Get | `Post ] wrap -> [> `Formmethod ] attrib
val a_multiple : unit -> [> `Multiple ] attrib
val a_name : Html_types.text wrap -> [> `Name ] attrib
val a_rows : Html_types.number wrap -> [> `Rows ] attrib
val a_selected : unit -> [> `Selected ] attrib
val a_size : Html_types.number wrap -> [> `Size ] attrib
val a_src : Xml.uri wrap -> [> `Src ] attrib
val a_input_type : [< `Button | `Checkbox | `Color | `Date | `Datetime | `Datetime_local | `Email | `File | `Hidden | `Image | `Month | `Number | `Password | `Radio | `Range | `Reset | `Search | `Submit | `Tel | `Text | `Time | `Url | `Week ] wrap -> [> `Input_Type ] attrib
val a_text_value : Html_types.text wrap -> [> `Text_Value ] attrib
val a_int_value : Html_types.number wrap -> [> `Int_Value ] attrib
val a_value : Html_types.cdata wrap -> [> `Value ] attrib
val a_float_value : Html_types.float_number wrap -> [> `Float_Value ] attrib
val a_disabled : unit -> [> `Disabled ] attrib
val a_readonly : unit -> [> `ReadOnly ] attrib
val a_button_type : [< `Button | `Reset | `Submit ] wrap -> [> `Button_Type ] attrib
val a_script_type : Html_types.script_type wrap -> [> `Script_type ] attrib
val a_command_type : [< `Checkbox | `Command | `Radio ] wrap -> [> `Command_Type ] attrib
val a_menu_type : [< `Context | `Toolbar ] wrap -> [> `Menu_Type ] attrib
val a_label : Html_types.text wrap -> [> `Label ] attrib
val a_align : [< `Char | `Justify | `Left | `Right ] wrap -> [> `Align ] attrib
  • deprecated Use CSS text-align
val a_axis : Html_types.cdata wrap -> [> `Axis ] attrib
  • deprecated Not supported in HTML5
val a_colspan : Html_types.number wrap -> [> `Colspan ] attrib
val a_headers : Html_types.idrefs wrap -> [> `Headers ] attrib
val a_rowspan : Html_types.number wrap -> [> `Rowspan ] attrib
val a_scope : [< `Col | `Colgroup | `Row | `Rowgroup ] wrap -> [> `Scope ] attrib
  • deprecated Not supported in HTML5
val a_summary : Html_types.text wrap -> [> `Summary ] attrib
  • deprecated Move content elsewhere or to a <caption> child
val a_border : Html_types.pixels wrap -> [> `Border ] attrib
  • deprecated Use CSS border and/or border-width
val a_rules : [< `All | `Cols | `Groups | `None | `Rows ] wrap -> [> `Rules ] attrib
  • deprecated Use CSS border
val a_char : Html_types.character wrap -> [> `Char ] attrib
  • deprecated The char attribute is not supported in HTML5
val a_alt : Html_types.text wrap -> [> `Alt ] attrib
val a_height : Html_types.number wrap -> [> `Height ] attrib
val a_width : Html_types.number wrap -> [> `Width ] attrib
type shape = [
  1. | `Circle
  2. | `Default
  3. | `Poly
  4. | `Rect
]
val a_shape : shape wrap -> [> `Shape ] attrib
val a_coords : Html_types.numbers wrap -> [> `Coords ] attrib
val a_usemap : Html_types.idref wrap -> [> `Usemap ] attrib
val a_data : Xml.uri wrap -> [> `Data ] attrib
val a_codetype : Html_types.contenttype wrap -> [> `Codetype ] attrib
  • deprecated Not supported in HTML5
val a_frameborder : [< `One | `Zero ] wrap -> [> `Frameborder ] attrib
  • deprecated Use CSS border
val a_marginheight : Html_types.pixels wrap -> [> `Marginheight ] attrib
  • deprecated Use CSS margin
val a_marginwidth : Html_types.pixels wrap -> [> `Marginwidth ] attrib
  • deprecated Use CSS margin
val a_scrolling : [< `Auto | `No | `Yes ] wrap -> [> `Scrolling ] attrib
val a_target : Html_types.frametarget wrap -> [> `Target ] attrib
val a_content : Html_types.text wrap -> [> `Content ] attrib
val a_http_equiv : Html_types.text wrap -> [> `Http_equiv ] attrib
val a_defer : unit -> [> `Defer ] attrib
val a_media : Html_types.mediadesc wrap -> [> `Media ] attrib
val a_style : string wrap -> [> `Style_Attr ] attrib
val a_property : string wrap -> [> `Property ] attrib
val a_role : string list wrap -> [> `Role ] attrib
val a_aria : string -> string list wrap -> [> `Aria ] attrib
val txt : string wrap -> [> Html_types.txt ] elt
val body : ([< Html_types.body_attrib ], [< Html_types.body_content_fun ], [> Html_types.body ]) star
val svg : ?a:[< Html_types.svg_attrib ] Svg.D.Raw'.attrib list -> [< Html_types.svg_content ] Svg.D.Raw'.elt list_wrap -> [> Html_types.svg ] elt
val article : ([< Html_types.article_attrib ], [< Html_types.article_content_fun ], [> Html_types.article ]) star
val figure : ?figcaption: [ `Bottom of [< Html_types.figcaption ] elt wrap | `Top of [< Html_types.figcaption ] elt wrap ] -> ([< Html_types.figure_attrib ], [< Html_types.figure_content_fun ], [> Html_types.figure ]) star
val bdo : dir:[< `Ltr | `Rtl ] wrap -> ([< Html_types.bdo_attrib ], [< Html_types.bdo_content_fun ], [> Html_types.bdo ]) star
val a : ([< Html_types.a_attrib ], 'a, [> 'a Html_types.a ]) star
val del : ([< Html_types.del_attrib ], 'a, [> 'a Html_types.del ]) star
val ins : ([< Html_types.ins_attrib ], 'a, [> 'a Html_types.ins ]) star
val object_ : ?params:[< Html_types.param ] elt list_wrap -> ([< Html_types.object__attrib ], 'a, [> `Object of 'a ]) star
val audio : ?src:Xml.uri wrap -> ?srcs:[< Html_types.source ] elt list_wrap -> ([< Html_types.audio_attrib ], 'a, [> 'a Html_types.audio ]) star
val video : ?src:Xml.uri wrap -> ?srcs:[< Html_types.source ] elt list_wrap -> ([< Html_types.video_attrib ], 'a, [> 'a Html_types.video ]) star
val canvas : ([< Html_types.canvas_attrib ], 'a, [> 'a Html_types.canvas ]) star
val area : alt:Html_types.text wrap -> ([< `Accesskey | `Alt | `Aria | `Class | `Contenteditable | `Contextmenu | `Coords | `Dir | `Draggable | `Hidden | `Hreflang | `Id | `Lang | `Media | `Mime_type | `OnAbort | `OnBlur | `OnCanPlay | `OnCanPlayThrough | `OnChange | `OnClick | `OnClose | `OnContextMenu | `OnDblClick | `OnDrag | `OnDragEnd | `OnDragEnter | `OnDragLeave | `OnDragOver | `OnDragStart | `OnDrop | `OnDurationChange | `OnEmptied | `OnEnded | `OnError | `OnFocus | `OnFormChange | `OnFormInput | `OnInput | `OnInvalid | `OnKeyDown | `OnKeyPress | `OnKeyUp | `OnLoad | `OnLoadStart | `OnLoadedData | `OnLoadedMetaData | `OnMouseDown | `OnMouseMove | `OnMouseOut | `OnMouseOver | `OnMouseUp | `OnMouseWheel | `OnPause | `OnPlay | `OnPlaying | `OnProgress | `OnRateChange | `OnReadyStateChange | `OnScroll | `OnSeeked | `OnSeeking | `OnSelect | `OnShow | `OnStalled | `OnSubmit | `OnSuspend | `OnTimeUpdate | `OnTouchCancel | `OnTouchEnd | `OnTouchMove | `OnTouchStart | `OnVolumeChange | `OnWaiting | `Rel | `Role | `Shape | `Spellcheck | `Style_Attr | `Tabindex | `Target | `Title | `Translate | `User_data | `XML_lang | `XMLns ], [> Html_types.area ]) nullary
val map : ([< Html_types.map_attrib ], 'a, [> 'a Html_types.map ]) star
val datalist : ?children: [< `Options of [< Html_types.selectoption ] elt list_wrap | `Phras of [< Html_types.phrasing ] elt list_wrap ] -> ([< Html_types.datalist_attrib ], [> Html_types.datalist ]) nullary
val entity : string -> [> Html_types.txt ] elt
val space : unit -> [> Html_types.txt ] elt
val cdata : string -> [> Html_types.txt ] elt
val cdata_script : string -> [> Html_types.txt ] elt
val cdata_style : string -> [> Html_types.txt ] elt
val menu : ?children: [< `Flows of [< Html_types.flow5 ] elt list_wrap | `Lis of [< `Li of [< Html_types.common ] ] elt list_wrap ] -> ([< Html_types.menu_attrib ], [> Html_types.menu ]) nullary
val pcdata : string wrap -> [> Html_types.pcdata ] elt
  • deprecated Use txt instead
val tot : Xml.elt -> 'a elt
val totl : Xml.elt list_wrap -> 'a elt list_wrap
val toelt : 'a elt -> Xml.elt
val toeltl : 'a elt list_wrap -> Xml.elt list_wrap
val doc_toelt : doc -> Xml.elt
val to_xmlattribs : 'a attrib list -> Xml.attrib list
val to_attrib : Xml.attrib -> 'a attrib
module Unsafe : sig ... end
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