htmlit 0.1.0 (latest) · OCaml Package

HTML attributes.

See the attribute constructors.

Attributes

type name = string

The type for attribute names.

type t

The type for attributes.

val v : name -> string -> t

v n value is an attribute named n with value value. Favour use of attribute constructors whenever possible.

val void : t

void is v "" "", an attribute that doesn't get rendered. See also is_void.

val int : name -> int -> t

int n i is v n (string_of_int i).

val true' : name -> t

true' n is v n "". This sets the boolean attribute n to true. The attribute must be omitted to be false. See also if' and if_some.

val if' : bool -> t -> t

if' cond at is if cond then at else void.

val if_some : t option -> t

if_some o is at if o is Some at and void if o is None.

Predicates and comparisons

val is_void : t -> bool

is_void at is true iff the name of at is empty. These attributes render nothing. See also void.

val equal : t -> t -> bool

equal at0 at1 is true if both the name and value of at0 and at1 are String.equal.

val compare : t -> t -> int

compare is a total order on attributes compatible with equal.

Converting and formatting

val to_pair : t -> string * string

to_pair at is (n, v) the name and value of the attribute.

val of_pair : (string * string) -> t

of_pair (n, value) is v n value.

val pp : Stdlib.Format.formatter -> t -> unit

pp ppf at formats at on ppf using HTML syntax. is_void attributes format nothing.

Attribute constructors

See the MDN HTML attribute reference.

type 'a cons = 'a -> t

The type for attribute constructors with attribute values of type 'a.

val accesskey : string cons

accesskey

val action : string cons

action

val alt : string cons

alt

val autocomplete : string cons

autocomplete

val autofocus : t

autofocus

val charset : string cons

charset

val checked : t

checked

val class' : string cons

class

val cols : int cons

cols

val colspan : int cons

colspan

val content : string cons

content

val contenteditable : bool cons

contenteditable

val datetime : string cons

datetime

val defer : t

defer

val dir : string cons

dir

val disabled : t

disabled

val draggable : bool cons

draggable

val for' : string cons

for'

val height : int cons

height

val hidden : t

hidden

val href : string cons

href

val id : string cons

val lang : string cons

lang

val list : string cons

list

val media : string cons

media

val method' : string cons

method.

val name : string cons

name

val placeholder : string cons

placeholder

val rel : string cons

rel

val required : t

required

val rows : int cons

rows

val rowspan : int cons

rowspan

val selected : t

selected

val spellcheck : string cons

spellcheck

val src : string cons

src

val style : string cons

style

val tabindex : int cons

tabindex

val title : string cons

title

val type' : string cons

type

val value : string cons

value

val wrap : string cons

wrap

val width : int cons

width

package htmlit

Attributes

Predicates and comparisons

Converting and formatting

Attribute constructors