Up – 🏠 » tyxml » Library tyxml.functor » Html_f » Make

Module `Html_f.Make`Source

Create a new implementation of HTML, using the given underlying Xml and Svg implementation. Will output a module of type Html_sigs.T with the various type equalities.

If your Xml implementation uses a special function wrapping, use Make_with_wrapped_functions.

Parameters

module Xml : Xml_sigs.T with type ('a, 'b) W.ft = 'a -> 'b

module Svg : Svg_sigs.T with module Xml := Xml

Signature

Sourcetype +'a elt = Xml.elt

HTML elements.

Element constructors are in section elements. Most elements constructors are either nullary, unary or star, depending on the number of children they accept. Children are usually given as a list of elements. txt is used for text.

div [a [txt "Foo"]] is equivalent to <div><a>foo</a></div>

The type variable 'a is used to track the element's type. This allows the OCaml typechecker to check HTML validity.

For example, div [] is of type [> `Div] elt. The span function only accepts children of type Html_types.span_content. Since `Div is not part of it. span [div []] will not typecheck.

Note that the concrete implementation of this type can vary. See Xml for details.

Sourcetype doc = Html_types.html elt

A complete HTML document.

Sourcetype +'a attrib = Xml.attrib

HTML attributes

Attribute constructors are in section attributes and their name starts with a_. Attributes are given to elements with the ~a optional argument.

a ~a:[a_href "ocsigen.org"] [txt "link!"] is equivalent to <a href="ocsigen.org">link!</a>

Similarly to elt, attributes use the OCaml type system to enforce HTML validity.

For example a_href returns a value of type [> `Href] attrib. The div function only accepts attributes of type Html_types.div_attrib. Since `Href is not part of it, div ~a:[a_href "ocsigen.org"] [] will not typecheck.

In some cases, attributes have to be disambiguated. The max attribute has two version, a_max and a_input_max, depending on the element. Such disambiguated attribute will contain the name of the associated element.

module Xml : 
  Xml_sigs.T
    with type 'a W.t = 'a Xml.W.t
    with type 'a W.tlist = 'a Xml.W.tlist
    with type ('a, 'b) W.ft = ('a, 'b) Xml.W.ft
    with type uri = Xml.uri
    with type event_handler = Xml.event_handler
    with type mouse_event_handler = Xml.mouse_event_handler
    with type keyboard_event_handler = Xml.keyboard_event_handler
    with type touch_event_handler = Xml.touch_event_handler
    with type attrib = Xml.attrib
    with type elt = Xml.elt

Underlying XML data-structure

Sourcetype 'a wrap = 'a Xml.W.t

wrap is a container for elements and values.

In most cases, 'a wrap = 'a. For R modules (in eliom or js_of_ocaml), It will be React.S.t.

Sourcetype 'a list_wrap = 'a Xml.W.tlist

list_wrap is a container for list of elements.

In most cases, 'a list_wrap = 'a list. For R modules (in eliom or js_of_ocaml), It will be ReactiveData.RList.t.

Sourcetype ('a, 'b) nullary = ?a:'a attrib list -> unit -> 'b elt

A nullary element is an element that doesn't have any children.

Sourcetype ('a, 'b, 'c) unary = ?a:'a attrib list -> 'b elt wrap -> 'c elt

A unary element is an element that have exactly one children.

Sourcetype ('a, 'b, 'c) star = ?a:'a attrib list -> 'b elt list_wrap -> 'c elt

A star element is an element that has any number of children, including zero.

Sourcemodule Info : Xml_sigs.Info

Various information about HTML, such as the doctype, ...

Uri

Sourcetype uri = Xml.uri

Sourceval string_of_uri : (uri, string) Xml.W.ft

Sourceval uri_of_string : (string, uri) Xml.W.ft

Attributes

Sourceval a_class : Html_types.nmtokens wrap -> [> `Class ] attrib

This attribute assigns a class name or set of class names to an element. Any number of elements may be assigned the same class name or names.

val a_user_data : 
  Html_types.nmtoken ->
  Html_types.text wrap ->
  [> `User_data ] attrib

May be used to specify custom attributes. The example given by the W3C is as follows :

<ol>
  <li data-length="2m11s">Beyond The Sea</li>
</ol>

It should be used for preprocessing ends only.

Sourceval a_id : Html_types.text wrap -> [> `Id ] attrib

This attribute assigns a name to an element. This name must be unique in a document. The text should be without any space.

Sourceval a_title : Html_types.text wrap -> [> `Title ] attrib

This attribute offers advisory information about the element for which it is set.

Values of the title attribute may be rendered by user agents in a variety of ways. For instance, visual browsers frequently display the title as a tool tip (a short message that appears when the pointing device pauses over an object). Audio user agents may speak the title information in a similar context.

The title attribute has an additional role when used with the link element to designate an external style sheet. Please consult the section on links and style sheets for details.

I18N

Sourceval a_xml_lang : Html_types.languagecode wrap -> [> `XML_lang ] attrib

Sourceval a_lang : Html_types.languagecode wrap -> [> `Lang ] attrib

Events

Javascript events

Sourceval a_onabort : Xml.event_handler -> [> `OnAbort ] attrib

Sourceval a_onafterprint : Xml.event_handler -> [> `OnAfterPrint ] attrib

Sourceval a_onbeforeprint : Xml.event_handler -> [> `OnBeforePrint ] attrib

Sourceval a_onbeforeunload : Xml.event_handler -> [> `OnBeforeUnload ] attrib

Sourceval a_onblur : Xml.event_handler -> [> `OnBlur ] attrib

Sourceval a_oncanplay : Xml.event_handler -> [> `OnCanPlay ] attrib

Sourceval a_oncanplaythrough : Xml.event_handler -> [> `OnCanPlayThrough ] attrib

Sourceval a_onchange : Xml.event_handler -> [> `OnChange ] attrib

Sourceval a_onclose : Xml.event_handler -> [> `OnClose ] attrib

Sourceval a_ondurationchange : Xml.event_handler -> [> `OnDurationChange ] attrib

Sourceval a_onemptied : Xml.event_handler -> [> `OnEmptied ] attrib

Sourceval a_onended : Xml.event_handler -> [> `OnEnded ] attrib

Sourceval a_onerror : Xml.event_handler -> [> `OnError ] attrib

Sourceval a_onfocus : Xml.event_handler -> [> `OnFocus ] attrib

Sourceval a_onformchange : Xml.event_handler -> [> `OnFormChange ] attrib

Sourceval a_onforminput : Xml.event_handler -> [> `OnFormInput ] attrib

Sourceval a_onhashchange : Xml.event_handler -> [> `OnHashChange ] attrib

Sourceval a_oninput : Xml.event_handler -> [> `OnInput ] attrib

Sourceval a_oninvalid : Xml.event_handler -> [> `OnInvalid ] attrib

Sourceval a_onmousewheel : Xml.event_handler -> [> `OnMouseWheel ] attrib

Sourceval a_onoffline : Xml.event_handler -> [> `OnOffLine ] attrib

Sourceval a_ononline : Xml.event_handler -> [> `OnOnLine ] attrib

Sourceval a_onpause : Xml.event_handler -> [> `OnPause ] attrib

Sourceval a_onplay : Xml.event_handler -> [> `OnPlay ] attrib

Sourceval a_onplaying : Xml.event_handler -> [> `OnPlaying ] attrib

Sourceval a_onpagehide : Xml.event_handler -> [> `OnPageHide ] attrib

Sourceval a_onpageshow : Xml.event_handler -> [> `OnPageShow ] attrib

Sourceval a_onpopstate : Xml.event_handler -> [> `OnPopState ] attrib

Sourceval a_onprogress : Xml.event_handler -> [> `OnProgress ] attrib

Sourceval a_onratechange : Xml.event_handler -> [> `OnRateChange ] attrib

Sourceval a_onreadystatechange : Xml.event_handler -> [> `OnReadyStateChange ] attrib

Sourceval a_onredo : Xml.event_handler -> [> `OnRedo ] attrib

Sourceval a_onresize : Xml.event_handler -> [> `OnResize ] attrib

Sourceval a_onscroll : Xml.event_handler -> [> `OnScroll ] attrib

Sourceval a_onseeked : Xml.event_handler -> [> `OnSeeked ] attrib

Sourceval a_onseeking : Xml.event_handler -> [> `OnSeeking ] attrib

Sourceval a_onselect : Xml.event_handler -> [> `OnSelect ] attrib

Sourceval a_onshow : Xml.event_handler -> [> `OnShow ] attrib

Sourceval a_onstalled : Xml.event_handler -> [> `OnStalled ] attrib

Sourceval a_onstorage : Xml.event_handler -> [> `OnStorage ] attrib

Sourceval a_onsubmit : Xml.event_handler -> [> `OnSubmit ] attrib

Sourceval a_onsuspend : Xml.event_handler -> [> `OnSuspend ] attrib

Sourceval a_ontimeupdate : Xml.event_handler -> [> `OnTimeUpdate ] attrib

Sourceval a_onundo : Xml.event_handler -> [> `OnUndo ] attrib

Sourceval a_onunload : Xml.event_handler -> [> `OnUnload ] attrib

Sourceval a_onvolumechange : Xml.event_handler -> [> `OnVolumeChange ] attrib

Sourceval a_onwaiting : Xml.event_handler -> [> `OnWaiting ] attrib

Sourceval a_onload : Xml.event_handler -> [> `OnLoad ] attrib

Sourceval a_onloadeddata : Xml.event_handler -> [> `OnLoadedData ] attrib

Sourceval a_onloadedmetadata : Xml.event_handler -> [> `OnLoadedMetaData ] attrib

Sourceval a_onloadstart : Xml.event_handler -> [> `OnLoadStart ] attrib

Sourceval a_onmessage : Xml.event_handler -> [> `OnMessage ] attrib

Mouse events

Sourceval a_onclick : Xml.mouse_event_handler -> [> `OnClick ] attrib

Sourceval a_oncontextmenu : Xml.mouse_event_handler -> [> `OnContextMenu ] attrib

Sourceval a_ondblclick : Xml.mouse_event_handler -> [> `OnDblClick ] attrib

Sourceval a_ondrag : Xml.mouse_event_handler -> [> `OnDrag ] attrib

Sourceval a_ondragend : Xml.mouse_event_handler -> [> `OnDragEnd ] attrib

Sourceval a_ondragenter : Xml.mouse_event_handler -> [> `OnDragEnter ] attrib

Sourceval a_ondragleave : Xml.mouse_event_handler -> [> `OnDragLeave ] attrib

Sourceval a_ondragover : Xml.mouse_event_handler -> [> `OnDragOver ] attrib

Sourceval a_ondragstart : Xml.mouse_event_handler -> [> `OnDragStart ] attrib

Sourceval a_ondrop : Xml.mouse_event_handler -> [> `OnDrop ] attrib

Sourceval a_onmousedown : Xml.mouse_event_handler -> [> `OnMouseDown ] attrib

Sourceval a_onmouseup : Xml.mouse_event_handler -> [> `OnMouseUp ] attrib

Sourceval a_onmouseover : Xml.mouse_event_handler -> [> `OnMouseOver ] attrib

Sourceval a_onmousemove : Xml.mouse_event_handler -> [> `OnMouseMove ] attrib

Sourceval a_onmouseout : Xml.mouse_event_handler -> [> `OnMouseOut ] attrib

Sourceval a_ontouchstart : Xml.touch_event_handler -> [> `OnTouchStart ] attrib

Touch events

Sourceval a_ontouchend : Xml.touch_event_handler -> [> `OnTouchEnd ] attrib

Sourceval a_ontouchmove : Xml.touch_event_handler -> [> `OnTouchMove ] attrib

Sourceval a_ontouchcancel : Xml.touch_event_handler -> [> `OnTouchCancel ] attrib

Keyboard events

Sourceval a_onkeypress : Xml.keyboard_event_handler -> [> `OnKeyPress ] attrib

Sourceval a_onkeydown : Xml.keyboard_event_handler -> [> `OnKeyDown ] attrib

Sourceval a_onkeyup : Xml.keyboard_event_handler -> [> `OnKeyUp ] attrib

Other attributes

Sourceval a_allowfullscreen : unit -> [> `Allowfullscreen ] attrib

Sourceval a_allowpaymentrequest : unit -> [> `Allowpaymentrequest ] attrib

val a_autocomplete : 
  Html_types.autocomplete_option wrap ->
  [> `Autocomplete ] attrib

see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete
autocomplete documentation.

Sourceval a_async : unit -> [> `Async ] attrib

Sourceval a_autofocus : unit -> [> `Autofocus ] attrib

Sourceval a_autoplay : unit -> [> `Autoplay ] attrib

Sourceval a_muted : unit -> [> `Muted ] attrib

val a_crossorigin : 
  [< `Anonymous | `Use_credentials ] wrap ->
  [> `Crossorigin ] attrib

Sourceval a_integrity : string wrap -> [> `Integrity ] attrib

Sourceval a_mediagroup : string wrap -> [> `Mediagroup ] attrib

Sourceval a_challenge : Html_types.text wrap -> [> `Challenge ] attrib

Sourceval a_contenteditable : bool wrap -> [> `Contenteditable ] attrib

Sourceval a_contextmenu : Html_types.idref wrap -> [> `Contextmenu ] attrib

Sourceval a_controls : unit -> [> `Controls ] attrib

Sourceval a_dir : [< `Rtl | `Ltr ] wrap -> [> `Dir ] attrib

Sourceval a_draggable : bool wrap -> [> `Draggable ] attrib

Sourceval a_form : Html_types.idref wrap -> [> `Form ] attrib

Sourceval a_formaction : Xml.uri wrap -> [> `Formaction ] attrib

Sourceval a_formenctype : Html_types.contenttype wrap -> [> `Formenctype ] attrib

Sourceval a_formnovalidate : unit -> [> `Formnovalidate ] attrib

Sourceval a_formtarget : Html_types.text wrap -> [> `Formtarget ] attrib

Sourceval a_hidden : unit -> [> `Hidden ] attrib

Sourceval a_high : Html_types.float_number wrap -> [> `High ] attrib

Sourceval a_icon : Xml.uri wrap -> [> `Icon ] attrib

Sourceval a_ismap : unit -> [> `Ismap ] attrib

Sourceval a_keytype : Html_types.text wrap -> [> `Keytype ] attrib

Sourceval a_list : Html_types.idref wrap -> [> `List ] attrib

Sourceval a_loop : unit -> [> `Loop ] attrib

Sourceval a_low : Html_types.float_number wrap -> [> `High ] attrib

Sourceval a_max : Html_types.float_number wrap -> [> `Max ] attrib

Sourceval a_input_max : Html_types.number_or_datetime wrap -> [> `Input_Max ] attrib

Sourceval a_min : Html_types.float_number wrap -> [> `Min ] attrib

Sourceval a_input_min : Html_types.number_or_datetime wrap -> [> `Input_Min ] attrib

val a_inputmode : 
  [< `None | `Text | `Decimal | `Numeric | `Tel | `Search | `Email | `Url ]
    wrap ->
  [> `Inputmode ] attrib

see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
inputmode documentation.

Sourceval a_novalidate : unit -> [> `Novalidate ] attrib

Sourceval a_open : unit -> [> `Open ] attrib

Sourceval a_optimum : Html_types.float_number wrap -> [> `Optimum ] attrib

Sourceval a_pattern : Html_types.text wrap -> [> `Pattern ] attrib

Sourceval a_placeholder : Html_types.text wrap -> [> `Placeholder ] attrib

Sourceval a_poster : Xml.uri wrap -> [> `Poster ] attrib

Sourceval a_preload : [< `None | `Metadata | `Audio ] wrap -> [> `Preload ] attrib

Sourceval a_pubdate : unit -> [> `Pubdate ] attrib

Sourceval a_radiogroup : Html_types.text wrap -> [> `Radiogroup ] attrib

val a_referrerpolicy : 
  Html_types.referrerpolicy wrap ->
  [> `Referrerpolicy ] attrib

see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#Attributes

Sourceval a_required : unit -> [> `Required ] attrib

Sourceval a_reversed : unit -> [> `Reversed ] attrib

Sourceval a_sandbox : [< Html_types.sandbox_token ] list wrap -> [> `Sandbox ] attrib

Sourceval a_spellcheck : bool wrap -> [> `Spellcheck ] attrib

Sourceval a_scoped : unit -> [> `Scoped ] attrib

Sourceval a_seamless : unit -> [> `Seamless ] attrib

val a_sizes : 
  (Html_types.number * Html_types.number) list option wrap ->
  [> `Sizes ] attrib

Sourceval a_span : Html_types.number wrap -> [> `Span ] attrib

Sourceval a_srclang : Html_types.nmtoken wrap -> [> `XML_lang ] attrib

deprecated
Use a_xml_lang instead.

Sourcetype image_candidate = [

| `Url of uri
| `Url_width of uri * Html_types.number
| `Url_pixel of uri * Html_types.float_number

]

Sourceval a_srcset : image_candidate list wrap -> [> `Srcset ] attrib

Sourceval a_img_sizes : Html_types.text list wrap -> [> `Img_sizes ] attrib

Sourceval a_start : Html_types.number wrap -> [> `Start ] attrib

Sourceval a_step : Html_types.float_number option wrap -> [> `Step ] attrib

Sourceval a_translate : [< `Yes | `No ] wrap -> [> `Translate ] attrib

see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/translate
translate global attribute documentation.

Sourceval a_wrap : [< `Soft | `Hard ] wrap -> [> `Wrap ] attrib

Sourceval a_version : Html_types.cdata wrap -> [> `Version ] attrib

Sourceval a_xmlns : [< `W3_org_1999_xhtml ] wrap -> [> `XMLns ] attrib

Sourceval a_manifest : Xml.uri wrap -> [> `Manifest ] attrib

Sourceval a_cite : Xml.uri wrap -> [> `Cite ] attrib

Sourceval a_xml_space : [< `Default | `Preserve ] wrap -> [> `XML_space ] attrib

Sourceval a_accesskey : Html_types.character wrap -> [> `Accesskey ] attrib

This attribute assigns an access key to an element. An access key is a single character from the document character set. NB: authors should consider the input method of the expected reader when specifying an accesskey.

Sourceval a_charset : Html_types.charset wrap -> [> `Charset ] attrib

This attribute specifies the character encoding of the resource designated by the link. Please consult the section on character encodings for more details.

Sourceval a_accept_charset : Html_types.charsets wrap -> [> `Accept_charset ] attrib

Sourceval a_accept : Html_types.contenttypes wrap -> [> `Accept ] attrib

Sourceval a_href : Xml.uri wrap -> [> `Href ] attrib

This attribute specifies the location of a Web resource, thus defining a link between the current element (the source anchor) and the destination anchor defined by this attribute.

Sourceval a_hreflang : Html_types.languagecode wrap -> [> `Hreflang ] attrib

This attribute specifies the base language of the resource designated by href and may only be used when href is specified.

Sourceval a_download : string option wrap -> [> `Download ] attrib

Sourceval a_rel : Html_types.linktypes wrap -> [> `Rel ] attrib

This attribute describes the relationship from the current document to the anchor specified by the href attribute. The value of this attribute is a space-separated list of link types.

This attribute is used to describe a reverse link from the anchor specified by the href attribute to the current document. The value of this attribute is a space-separated list of link types.

Sourceval a_tabindex : Html_types.number wrap -> [> `Tabindex ] attrib

This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros.

Sourceval a_mime_type : Html_types.contenttype wrap -> [> `Mime_type ] attrib

This attribute gives an advisory hint as to the content type of the content available at the link target address. It allows user agents to opt to use a fallback mechanism rather than fetch the content if they are advised that they will get content in a content type they do not support.Authors who use this attribute take responsibility to manage the risk that it may become inconsistent with the content available at the link target address.

Sourceval a_datetime : Html_types.cdata wrap -> [> `Datetime ] attrib

Sourceval a_action : Xml.uri wrap -> [> `Action ] attrib

This attribute specifies a form processing agent. User agent behavior for a value other than an HTTP URI is undefined.

Sourceval a_checked : unit -> [> `Checked ] attrib

When the type attribute has the value "radio" or "checkbox", this boolean attribute specifies that the button is on. User agents must ignore this attribute for other control types.

Sourceval a_cols : Html_types.number wrap -> [> `Cols ] attrib

This attribute specifies the visible width in average character widths. Users should be able to enter longer lines than this, so user agents should provide some means to scroll through the contents of the control when the contents extend beyond the visible area. User agents may wrap visible text lines to keep long lines visible without the need for scrolling.

Sourceval a_enctype : Html_types.contenttype wrap -> [> `Enctype ] attrib

Sourceval a_label_for : Html_types.idref wrap -> [> `Label_for ] attrib

Sourceval a_for : Html_types.idref wrap -> [> `Label_for ] attrib

deprecated
Use a_label_for

Sourceval a_output_for : Html_types.idrefs wrap -> [> `Output_for ] attrib

Sourceval a_for_list : Html_types.idrefs wrap -> [> `Output_for ] attrib

deprecated
Use a_output_for

Sourceval a_maxlength : Html_types.number wrap -> [> `Maxlength ] attrib

Sourceval a_minlength : Html_types.number wrap -> [> `Minlength ] attrib

Sourceval a_method : [< `Get | `Post ] wrap -> [> `Method ] attrib

Sourceval a_formmethod : [< `Get | `Post ] wrap -> [> `Formmethod ] attrib

Sourceval a_multiple : unit -> [> `Multiple ] attrib

Sourceval a_name : Html_types.text wrap -> [> `Name ] attrib

This attribute assigns the control name.

Sourceval a_rows : Html_types.number wrap -> [> `Rows ] attrib

This attribute specifies the number of visible text lines. Users should be able to enter more lines than this, so user agents should provide some means to scroll through the contents of the control when the contents extend beyond the visible area.

Sourceval a_selected : unit -> [> `Selected ] attrib

When set, this boolean attribute specifies that this option is pre-selected.

Sourceval a_size : Html_types.number wrap -> [> `Size ] attrib

Sourceval a_src : Xml.uri wrap -> [> `Src ] attrib

val a_input_type : 
  [< `Url
  | `Tel
  | `Text
  | `Time
  | `Search
  | `Password
  | `Checkbox
  | `Range
  | `Radio
  | `Submit
  | `Reset
  | `Number
  | `Hidden
  | `Month
  | `Week
  | `File
  | `Email
  | `Image
  | `Datetime_local
  | `Datetime
  | `Date
  | `Color
  | `Button ]
    wrap ->
  [> `Input_Type ] attrib

Sourceval a_text_value : Html_types.text wrap -> [> `Text_Value ] attrib

This attribute specifies the initial value of the control. If this attribute is not set, the initial value is set to the contents of the option element.

Sourceval a_int_value : Html_types.number wrap -> [> `Int_Value ] attrib

Sourceval a_value : Html_types.cdata wrap -> [> `Value ] attrib

Sourceval a_float_value : Html_types.float_number wrap -> [> `Float_Value ] attrib

Sourceval a_disabled : unit -> [> `Disabled ] attrib

Sourceval a_readonly : unit -> [> `ReadOnly ] attrib

val a_button_type : 
  [< `Button | `Submit | `Reset ] wrap ->
  [> `Button_Type ] attrib

Sourceval a_script_type : Html_types.script_type wrap -> [> `Script_type ] attrib

val a_command_type : 
  [< `Command | `Checkbox | `Radio ] wrap ->
  [> `Command_Type ] attrib

Sourceval a_menu_type : [< `Context | `Toolbar ] wrap -> [> `Menu_Type ] attrib

Sourceval a_label : Html_types.text wrap -> [> `Label ] attrib

Sourceval a_align : [< `Left | `Right | `Justify | `Char ] wrap -> [> `Align ] attrib

deprecated
Use CSS text-align

Sourceval a_axis : Html_types.cdata wrap -> [> `Axis ] attrib

deprecated
Not supported in HTML5

Sourceval a_colspan : Html_types.number wrap -> [> `Colspan ] attrib

Sourceval a_headers : Html_types.idrefs wrap -> [> `Headers ] attrib

Sourceval a_rowspan : Html_types.number wrap -> [> `Rowspan ] attrib

val a_scope : 
  [< `Row | `Col | `Rowgroup | `Colgroup ] wrap ->
  [> `Scope ] attrib

deprecated
Not supported in HTML5

Sourceval a_summary : Html_types.text wrap -> [> `Summary ] attrib

deprecated
Move content elsewhere or to a <caption> child

Sourceval a_border : Html_types.pixels wrap -> [> `Border ] attrib

deprecated
Use CSS border and/or border-width

val a_rules : 
  [< `None | `Groups | `Rows | `Cols | `All ] wrap ->
  [> `Rules ] attrib

deprecated
Use CSS border

Sourceval a_char : Html_types.character wrap -> [> `Char ] attrib

deprecated
The char attribute is not supported in HTML5

Sourceval a_alt : Html_types.text wrap -> [> `Alt ] attrib

Sourceval a_height : Html_types.number wrap -> [> `Height ] attrib

Sourceval a_width : Html_types.number wrap -> [> `Width ] attrib

Sourcetype shape = [

| `Rect
| `Circle
| `Poly
| `Default

]

Sourceval a_shape : shape wrap -> [> `Shape ] attrib

Sourceval a_coords : Html_types.numbers wrap -> [> `Coords ] attrib

Sourceval a_usemap : Html_types.idref wrap -> [> `Usemap ] attrib

Sourceval a_data : Xml.uri wrap -> [> `Data ] attrib

Sourceval a_codetype : Html_types.contenttype wrap -> [> `Codetype ] attrib

deprecated
Not supported in HTML5

Sourceval a_frameborder : [< `Zero | `One ] wrap -> [> `Frameborder ] attrib

deprecated
Use CSS border

Sourceval a_marginheight : Html_types.pixels wrap -> [> `Marginheight ] attrib

deprecated
Use CSS

Sourceval a_marginwidth : Html_types.pixels wrap -> [> `Marginwidth ] attrib

deprecated
Use CSS

Sourceval a_scrolling : [< `Yes | `No | `Auto ] wrap -> [> `Scrolling ] attrib

Sourceval a_target : Html_types.frametarget wrap -> [> `Target ] attrib

Sourceval a_content : Html_types.text wrap -> [> `Content ] attrib

Sourceval a_http_equiv : Html_types.text wrap -> [> `Http_equiv ] attrib

Sourceval a_defer : unit -> [> `Defer ] attrib

Sourceval a_media : Html_types.mediadesc wrap -> [> `Media ] attrib

Sourceval a_style : string wrap -> [> `Style_Attr ] attrib

Sourceval a_property : string wrap -> [> `Property ] attrib

ARIA support

WAI-ARIA is a specification written by the W3C, defining a set of additional HTML attributes that can be applied to elements to provide additional semantics and improve accessibility wherever it is lacking.

See for example a WAI-ARIA tutorial.

Sourceval a_role : string list wrap -> [> `Role ] attrib

see https://www.w3.org/TR/role-attribute
Role attribute specification

see https://www.w3.org/TR/wai-aria-1.1/#role_definitions
List of WAI-ARIA roles

Sourceval a_aria : string -> string list wrap -> [> `Aria ] attrib

Basic support for WAI-ARIA attributes: a_aria "foo" corresponds to an "aria-foo" attribute.

see https://www.w3.org/TR/wai-aria-1.1/#state_prop_def
List of WAI-ARIA attributes

Elements

Sourceval txt : string wrap -> [> Html_types.txt ] elt

val html : 
  ?a:Html_types.html_attrib attrib list ->
  [< Html_types.head ] elt wrap ->
  [< Html_types.body ] elt wrap ->
  [> Html_types.html ] elt

val head : 
  ?a:Html_types.head_attrib attrib list ->
  [< Html_types.title ] elt wrap ->
  Html_types.head_content_fun elt list_wrap ->
  [> Html_types.head ] elt

Sourceval base : ([< Html_types.base_attrib ], [> Html_types.base ]) nullary

val title : 
  (Html_types.title_attrib,
    [< Html_types.title_content_fun ],
    [> Html_types.title ])
    unary

val body : 
  ([< Html_types.body_attrib ],
    [< Html_types.body_content_fun ],
    [> Html_types.body ])
    star

val svg : 
  ?a:[< Html_types.svg_attrib ] Svg.attrib list ->
  [< Html_types.svg_content ] Svg.elt list_wrap ->
  [> Html_types.svg ] elt

Section

val footer : 
  ([< Html_types.footer_attrib ],
    [< Html_types.footer_content_fun ],
    [> Html_types.footer ])
    star

val header : 
  ([< Html_types.header_attrib ],
    [< Html_types.header_content_fun ],
    [> Html_types.header ])
    star

val section : 
  ([< Html_types.section_attrib ],
    [< Html_types.section_content_fun ],
    [> Html_types.section ])
    star

val nav : 
  ([< Html_types.nav_attrib ],
    [< Html_types.nav_content_fun ],
    [> Html_types.nav ])
    star

val h1 : 
  ([< Html_types.h1_attrib ],
    [< Html_types.h1_content_fun ],
    [> Html_types.h1 ])
    star

val h2 : 
  ([< Html_types.h2_attrib ],
    [< Html_types.h2_content_fun ],
    [> Html_types.h2 ])
    star

val h3 : 
  ([< Html_types.h3_attrib ],
    [< Html_types.h3_content_fun ],
    [> Html_types.h3 ])
    star

val h4 : 
  ([< Html_types.h4_attrib ],
    [< Html_types.h4_content_fun ],
    [> Html_types.h4 ])
    star

val h5 : 
  ([< Html_types.h5_attrib ],
    [< Html_types.h5_content_fun ],
    [> Html_types.h5 ])
    star

val h6 : 
  ([< Html_types.h6_attrib ],
    [< Html_types.h6_content_fun ],
    [> Html_types.h6 ])
    star

val hgroup : 
  ([< Html_types.hgroup_attrib ],
    [< Html_types.hgroup_content_fun ],
    [> Html_types.hgroup ])
    star

val address : 
  ([< Html_types.address_attrib ],
    [< Html_types.address_content_fun ],
    [> Html_types.address ])
    star

val article : 
  ([< Html_types.article_attrib ],
    [< Html_types.article_content_fun ],
    [> Html_types.article ])
    star

val aside : 
  ([< Html_types.aside_attrib ],
    [< Html_types.aside_content_fun ],
    [> Html_types.aside ])
    star

val main : 
  ([< Html_types.main_attrib ],
    [< Html_types.main_content_fun ],
    [> Html_types.main ])
    star

Grouping content

val p : 
  ([< Html_types.p_attrib ], [< Html_types.p_content_fun ], [> Html_types.p ])
    star

val pre : 
  ([< Html_types.pre_attrib ],
    [< Html_types.pre_content_fun ],
    [> Html_types.pre ])
    star

val blockquote : 
  ([< Html_types.blockquote_attrib ],
    [< Html_types.blockquote_content_fun ],
    [> Html_types.blockquote ])
    star

val dialog : 
  ([< Html_types.dialog_attrib ],
    [< Html_types.dialog_content_fun ],
    [> Html_types.dialog ])
    star

see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dialog

val div : 
  ([< Html_types.div_attrib ],
    [< Html_types.div_content_fun ],
    [> Html_types.div ])
    star

val dl : 
  ([< Html_types.dl_attrib ],
    [< Html_types.dl_content_fun ],
    [> Html_types.dl ])
    star

val ol : 
  ([< Html_types.ol_attrib ],
    [< Html_types.ol_content_fun ],
    [> Html_types.ol ])
    star

val ul : 
  ([< Html_types.ul_attrib ],
    [< Html_types.ul_content_fun ],
    [> Html_types.ul ])
    star

val dd : 
  ([< Html_types.dd_attrib ],
    [< Html_types.dd_content_fun ],
    [> Html_types.dd ])
    star

val dt : 
  ([< Html_types.dt_attrib ],
    [< Html_types.dt_content_fun ],
    [> Html_types.dt ])
    star

val li : 
  ([< Html_types.li_attrib ],
    [< Html_types.li_content_fun ],
    [> Html_types.li ])
    star

val figcaption : 
  ([< Html_types.figcaption_attrib ],
    [< Html_types.figcaption_content_fun ],
    [> Html_types.figcaption ])
    star

val figure : 
  ?figcaption:
    [ `Top of [< Html_types.figcaption ] elt wrap
    | `Bottom of [< Html_types.figcaption ] elt wrap ] ->
  ([< Html_types.figure_attrib ],
    [< Html_types.figure_content_fun ],
    [> Html_types.figure ])
    star

Sourceval hr : ([< Html_types.hr_attrib ], [> Html_types.hr ]) nullary

Semantic

val b : 
  ([< Html_types.b_attrib ], [< Html_types.b_content_fun ], [> Html_types.b ])
    star

val i : 
  ([< Html_types.i_attrib ], [< Html_types.i_content_fun ], [> Html_types.i ])
    star

val u : 
  ([< Html_types.u_attrib ], [< Html_types.u_content_fun ], [> Html_types.u ])
    star

val small : 
  ([< Html_types.small_attrib ],
    [< Html_types.small_content_fun ],
    [> Html_types.small ])
    star

val sub : 
  ([< Html_types.sub_attrib ],
    [< Html_types.sub_content_fun ],
    [> Html_types.sub ])
    star

val sup : 
  ([< Html_types.sup_attrib ],
    [< Html_types.sup_content_fun ],
    [> Html_types.sup ])
    star

val mark : 
  ([< Html_types.mark_attrib ],
    [< Html_types.mark_content_fun ],
    [> Html_types.mark ])
    star

Sourceval wbr : ([< Html_types.wbr_attrib ], [> Html_types.wbr ]) nullary

val bdo : 
  dir:[< `Ltr | `Rtl ] wrap ->
  ([< Html_types.bdo_attrib ],
    [< Html_types.bdo_content_fun ],
    [> Html_types.bdo ])
    star

val abbr : 
  ([< Html_types.abbr_attrib ],
    [< Html_types.abbr_content_fun ],
    [> Html_types.abbr ])
    star

Sourceval br : ([< Html_types.br_attrib ], [> Html_types.br ]) nullary

val cite : 
  ([< Html_types.cite_attrib ],
    [< Html_types.cite_content_fun ],
    [> Html_types.cite ])
    star

val code : 
  ([< Html_types.code_attrib ],
    [< Html_types.code_content_fun ],
    [> Html_types.code ])
    star

val dfn : 
  ([< Html_types.dfn_attrib ],
    [< Html_types.dfn_content_fun ],
    [> Html_types.dfn ])
    star

val em : 
  ([< Html_types.em_attrib ],
    [< Html_types.em_content_fun ],
    [> Html_types.em ])
    star

val kbd : 
  ([< Html_types.kbd_attrib ],
    [< Html_types.kbd_content_fun ],
    [> Html_types.kbd ])
    star

val q : 
  ([< Html_types.q_attrib ], [< Html_types.q_content_fun ], [> Html_types.q ])
    star

val samp : 
  ([< Html_types.samp_attrib ],
    [< Html_types.samp_content_fun ],
    [> Html_types.samp ])
    star

val span : 
  ([< Html_types.span_attrib ],
    [< Html_types.span_content_fun ],
    [> Html_types.span ])
    star

val strong : 
  ([< Html_types.strong_attrib ],
    [< Html_types.strong_content_fun ],
    [> Html_types.strong ])
    star

val time : 
  ([< Html_types.time_attrib ],
    [< Html_types.time_content_fun ],
    [> Html_types.time ])
    star

val var : 
  ([< Html_types.var_attrib ],
    [< Html_types.var_content_fun ],
    [> Html_types.var ])
    star

Hypertext

Sourceval a : ([< Html_types.a_attrib ], 'a, [> 'a Html_types.a ]) star

Edit

Sourceval del : ([< Html_types.del_attrib ], 'a, [> 'a Html_types.del ]) star

Sourceval ins : ([< Html_types.ins_attrib ], 'a, [> 'a Html_types.ins ]) star

Embedded

val img : 
  src:Xml.uri wrap ->
  alt:Html_types.text wrap ->
  ([< Html_types.img_attrib ], [> Html_types.img ]) nullary

val picture : 
  img:[< Html_types.img ] elt wrap ->
  ([< Html_types.picture_attrib ],
    [< Html_types.picture_content_fun ],
    [> Html_types.picture ])
    star

see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/picture
Picture element documentation on MDN

val iframe : 
  ([< Html_types.iframe_attrib ],
    [< Html_types.iframe_content_fun ],
    [> Html_types.iframe ])
    star

val object_ : 
  ?params:[< Html_types.param ] elt list_wrap ->
  ([< Html_types.object__attrib ], 'a, [> `Object of 'a ]) star

Sourceval param : ([< Html_types.param_attrib ], [> Html_types.param ]) nullary

Sourceval embed : ([< Html_types.embed_attrib ], [> Html_types.embed ]) nullary

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

Sourceval source : ([< Html_types.source_attrib ], [> Html_types.source ]) nullary

val area : 
  alt:Html_types.text wrap ->
  ([< Html_types.common
   | `Alt
   | `Coords
   | `Shape
   | `Target
   | `Rel
   | `Media
   | `Hreflang
   | `Mime_type ],
    [> Html_types.area ])
    nullary

Sourceval map : ([< Html_types.map_attrib ], 'a, [> 'a Html_types.map ]) star

Tables Data

val caption : 
  ([< Html_types.caption_attrib ],
    [< Html_types.caption_content_fun ],
    [> Html_types.caption ])
    star

val table : 
  ?caption:[< Html_types.caption ] elt wrap ->
  ?columns:[< Html_types.colgroup ] elt list_wrap ->
  ?thead:[< Html_types.thead ] elt wrap ->
  ?tfoot:[< Html_types.tfoot ] elt wrap ->
  ([< Html_types.table_attrib ],
    [< Html_types.table_content_fun ],
    [> Html_types.table ])
    star

val tablex : 
  ?caption:[< Html_types.caption ] elt wrap ->
  ?columns:[< Html_types.colgroup ] elt list_wrap ->
  ?thead:[< Html_types.thead ] elt wrap ->
  ?tfoot:[< Html_types.tfoot ] elt wrap ->
  ([< Html_types.tablex_attrib ],
    [< Html_types.tablex_content_fun ],
    [> Html_types.tablex ])
    star

val colgroup : 
  ([< Html_types.colgroup_attrib ],
    [< Html_types.colgroup_content_fun ],
    [> Html_types.colgroup ])
    star

Sourceval col : ([< Html_types.col_attrib ], [> Html_types.col ]) nullary

val thead : 
  ([< Html_types.thead_attrib ],
    [< Html_types.thead_content_fun ],
    [> Html_types.thead ])
    star

val tbody : 
  ([< Html_types.tbody_attrib ],
    [< Html_types.tbody_content_fun ],
    [> Html_types.tbody ])
    star

val tfoot : 
  ([< Html_types.tfoot_attrib ],
    [< Html_types.tfoot_content_fun ],
    [> Html_types.tfoot ])
    star

val td : 
  ([< Html_types.td_attrib ],
    [< Html_types.td_content_fun ],
    [> Html_types.td ])
    star

val th : 
  ([< Html_types.th_attrib ],
    [< Html_types.th_content_fun ],
    [> Html_types.th ])
    star

val tr : 
  ([< Html_types.tr_attrib ],
    [< Html_types.tr_content_fun ],
    [> Html_types.tr ])
    star

Forms

val form : 
  ([< Html_types.form_attrib ],
    [< Html_types.form_content_fun ],
    [> Html_types.form ])
    star

val fieldset : 
  ?legend:[< Html_types.legend ] elt wrap ->
  ([< Html_types.fieldset_attrib ],
    [< Html_types.fieldset_content_fun ],
    [> Html_types.fieldset ])
    star

val legend : 
  ([< Html_types.legend_attrib ],
    [< Html_types.legend_content_fun ],
    [> Html_types.legend ])
    star

val label : 
  ([< Html_types.label_attrib ],
    [< Html_types.label_content_fun ],
    [> Html_types.label ])
    star

Label authorizes only one control inside them that should be labelled with a for attribute (although it is not necessary). Such constraints are not currently enforced by the type-system

Sourceval input : ([< Html_types.input_attrib ], [> Html_types.input ]) nullary

val button : 
  ([< Html_types.button_attrib ],
    [< Html_types.button_content_fun ],
    [> Html_types.button ])
    star

val select : 
  ([< Html_types.select_attrib ],
    [< Html_types.select_content_fun ],
    [> Html_types.select ])
    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 optgroup : 
  label:Html_types.text wrap ->
  ([< Html_types.optgroup_attrib ],
    [< Html_types.optgroup_content_fun ],
    [> Html_types.optgroup ])
    star

val option : 
  ([< Html_types.option_attrib ],
    [< Html_types.option_content_fun ],
    [> Html_types.selectoption ])
    unary

val textarea : 
  ([< Html_types.textarea_attrib ],
    [< Html_types.textarea_content_fun ],
    [> Html_types.textarea ])
    unary

Sourceval keygen : ([< Html_types.keygen_attrib ], [> Html_types.keygen ]) nullary

val progress : 
  ([< Html_types.progress_attrib ],
    [< Html_types.progress_content_fun ],
    [> Html_types.progress ])
    star

val meter : 
  ([< Html_types.meter_attrib ],
    [< Html_types.meter_content_fun ],
    [> Html_types.meter ])
    star

val output_elt : 
  ([< Html_types.output_elt_attrib ],
    [< Html_types.output_elt_content_fun ],
    [> Html_types.output_elt ])
    star

Data

Sourceval entity : string -> [> Html_types.txt ] elt

entity "foo" is the HTML entity &foo;. Both numerical and named form are allowed.

see http://www.w3schools.com/html/html_entities.asp
A tutorial on HTML entities.

see https://www.w3.org/TR/html5/syntax.html#named-character-references
The list of HTML entities.

Sourceval space : unit -> [> Html_types.txt ] elt

Sourceval cdata : string -> [> Html_types.txt ] elt

Sourceval cdata_script : string -> [> Html_types.txt ] elt

Sourceval cdata_style : string -> [> Html_types.txt ] elt

Interactive

val details : 
  [< Html_types.summary ] elt wrap ->
  ([< Html_types.details_attrib ],
    [< Html_types.details_content_fun ],
    [> Html_types.details ])
    star

val summary : 
  ([< Html_types.summary_attrib ],
    [< Html_types.summary_content_fun ],
    [> Html_types.summary ])
    star

val command : 
  label:Html_types.text wrap ->
  ([< Html_types.command_attrib ], [> Html_types.command ]) nullary

val menu : 
  ?children:
    [< `Lis of [< `Li of [< Html_types.common ] ] elt list_wrap
    | `Flows of [< Html_types.flow5 ] elt list_wrap ] ->
  ([< Html_types.menu_attrib ], [> Html_types.menu ]) nullary

Scripting

val script : 
  ([< Html_types.script_attrib ],
    [< Html_types.script_content_fun ],
    [> Html_types.script ])
    unary

val noscript : 
  ([< Html_types.noscript_attrib ],
    [< Html_types.noscript_content_fun ],
    [> Html_types.noscript ])
    star

val template : 
  ([< Html_types.template_attrib ],
    [< Html_types.template_content_fun ],
    [> Html_types.template ])
    star

see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/template
Template element documentation on MDN

Sourceval meta : ([< Html_types.meta_attrib ], [> Html_types.meta ]) nullary

Style Sheets

val style : 
  ([< Html_types.style_attrib ],
    [< Html_types.style_content_fun ],
    [> Html_types.style ])
    star

val link : 
  rel:Html_types.linktypes wrap ->
  href:Xml.uri wrap ->
  ([< Html_types.link_attrib ], [> Html_types.link ]) nullary

Ruby

val rt : 
  ([< Html_types.rt_attrib ],
    [< Html_types.rt_content_fun ],
    [> Html_types.rt ])
    star

val rp : 
  ([< Html_types.rp_attrib ],
    [< Html_types.rp_content_fun ],
    [> Html_types.rp ])
    star

val ruby : 
  ([< Html_types.ruby_attrib ],
    [< Html_types.ruby_content_fun ],
    [> Html_types.ruby ])
    star

Deprecated

Sourceval pcdata : string wrap -> [> Html_types.pcdata ] elt

deprecated
Use txt instead

Conversion with untyped representation

WARNING: These functions do not ensure HTML or SVG validity! You should always explicitly given an appropriate type to the output.

Sourceval of_seq : Xml_stream.signal Seq.t -> 'a elt list_wrap

import signal converts the given XML signal into Tyxml elements. It can be used with HTML and SVG parsing libraries, such as Markup.

raises Xml_stream.Malformed_stream
if the stream is malformed.

Sourceval tot : Xml.elt -> 'a elt

Sourceval totl : Xml.elt list_wrap -> 'a elt list_wrap

Sourceval toelt : 'a elt -> Xml.elt

Sourceval toeltl : 'a elt list_wrap -> Xml.elt list_wrap

Sourceval doc_toelt : doc -> Xml.elt

Sourceval to_xmlattribs : 'a attrib list -> Xml.attrib list

Sourceval to_attrib : Xml.attrib -> 'a attrib

Sourcemodule Unsafe : sig ... end

Unsafe features.