Dream_html.Ariahttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
val activedescendant : _ string_attrval atomic : attrval autocomplete : [ `inline | `list | `both ] to_attrval braillelabel : _ string_attrval brailleroledescription : _ string_attrval busy : attrval checked : [ `false_ | `true_ | `mixed ] to_attrval colcount : int to_attrval colindextext : _ string_attrval colspan : int to_attrval controls : _ string_attrval current : [ `page | `step | `location | `date | `time | `true_ ] to_attrval describedby : _ string_attrval description : _ string_attrval details : _ string_attrval disabled : attrval errormessage : _ string_attrval expanded : bool to_attrval flowto : _ string_attrval haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attrval invalid : [ `grammar | `spelling | `true_ ] to_attrval keyshortcuts : _ string_attrval label : _ string_attrval labelledby : _ string_attrval level : int to_attrval live : [ `assertive | `off | `polite ] to_attr⚠️ Screen readers want a live region to be defined statically from page load on a visible element, eg p [id "toast"; Aria.live `polite] []. The element must not be hidden initially, otherwise the screen reader will continue to ignore it even when its content is changed.
val modal : attrval multiline : attrval multiselectable : attrval orientation : [ `horizontal | `vertical ] to_attrval owns : _ string_attrval placeholder : _ string_attrval posinset : int to_attrval pressed : [ `false_ | `mixed | `true_ ] to_attrval readonly : attrval relevant : [ `additions | `all | `removals | `text ] to_attrval required : attrval roledescription : _ string_attrval rowcount : int to_attrval rowindex : int to_attrval rowindextext : _ string_attrval rowspan : int to_attrval selected : bool to_attrval setsize : int to_attrval sort : [ `ascending | `descending | `other ] to_attrval valuemax : float to_attrval valuemin : float to_attrval valuenow : float to_attrval valuetext : _ string_attrDream_html.Ariahttps://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
val activedescendant : _ string_attrval atomic : attrval autocomplete : [ `inline | `list | `both ] to_attrval braillelabel : _ string_attrval brailleroledescription : _ string_attrval busy : attrval checked : [ `false_ | `true_ | `mixed ] to_attrval colcount : int to_attrval colindextext : _ string_attrval colspan : int to_attrval controls : _ string_attrval current : [ `page | `step | `location | `date | `time | `true_ ] to_attrval describedby : _ string_attrval description : _ string_attrval details : _ string_attrval disabled : attrval errormessage : _ string_attrval expanded : bool to_attrval flowto : _ string_attrval haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attrval invalid : [ `grammar | `spelling | `true_ ] to_attrval keyshortcuts : _ string_attrval label : _ string_attrval labelledby : _ string_attrval level : int to_attrval live : [ `assertive | `off | `polite ] to_attr⚠️ Screen readers want a live region to be defined statically from page load on a visible element, eg p [id "toast"; Aria.live `polite] []. The element must not be hidden initially, otherwise the screen reader will continue to ignore it even when its content is changed.
`off since 3.10.0
val modal : attrval multiline : attrval multiselectable : attrval orientation : [ `horizontal | `vertical ] to_attrval owns : _ string_attrval placeholder : _ string_attrval posinset : int to_attrval pressed : [ `false_ | `mixed | `true_ ] to_attrval readonly : attrval relevant : [ `additions | `all | `removals | `text ] to_attrval required : attrval roledescription : _ string_attrval rowcount : int to_attrval rowindex : int to_attrval rowindextext : _ string_attrval rowspan : int to_attrval selected : bool to_attrval setsize : int to_attrval sort : [ `ascending | `descending | `other ] to_attrval valuemax : float to_attrval valuemin : float to_attrval valuenow : float to_attrval valuetext : _ string_attrDream_html.Atomval link : std_tagDream_html.AtomDream_html.FormTyped, extensible HTML form decoder with error reporting for form field validation failures. Powerful chained decoding functionality–the validation of one field can depend on the values of other decoded fields.
See the bottom of the page for complete examples.
The type of a decoder for a single form field value of type 'a which can successfully decode the field value or fail with an error message key.
In the following type decoders, the minimum and maximum values are all inclusive.
val bool : bool tyval char : ?min:char -> ?max:char -> char tyval float : ?min:float -> ?max:float -> float tyval int : ?min:int -> ?max:int -> int tyval int32 : ?min:int32 -> ?max:int32 -> int32 tyval int64 : ?min:int64 -> ?max:int64 -> int64 tyval string : ?min_length:int -> ?max_length:int -> string tyval unix_tm : ?min:Unix.tm -> ?max:Unix.tm -> Unix.tm tyThis can parse strings with the formats 2024-01-01 or 2024-01-01T00:00:00 into a timestamp.
Note that this is not timezone-aware.
The type of a form (a form field by itself is also considered a form) which can decode values of type 'a or fail with a list of error message keys.
val ok : 'a -> 'a tok value is a form field that always successfully returns value.
val error : string -> string -> 'a terror name message is a form field that always errors the field name with the message.
These allow adding adding further checks to the entire form using all decoded field values and then attaching more errors to specific fields (or not).
list ?min_length ?max_length ty name is a form field which can decode a list of values which can each be decoded by ty. The list must have at least min_length and at most max_length (inclusive).
optional ty name is a form field which can decode an optional value from the form.
required ?default ty name is a form field which can decode a required value from the form. If at least one value corresponding to the given name does not appear in the form, and if a default value is not specified, the decoding fails with an error.
multiple n form is a form which can decode a list of nested form values. It tries to decode exactly n values and fails if it can't find all of them. Assumes that the items are 0-indexed. See Multiple structured values for a complete example.
val ensure :
+Form (dream-html.Dream_html.Form) Module Dream_html.Form
Typed, extensible HTML form decoder with error reporting for form field validation failures. Powerful chained decoding functionality–the validation of one field can depend on the values of other decoded fields.
See the bottom of the page for complete examples.
Basic type decoders
The type of a decoder for a single form field value of type 'a which can successfully decode the field value or fail with an error message key.
In the following type decoders, the minimum and maximum values are all inclusive.
val bool : bool tyval char : ?min:char -> ?max:char -> char tyval float : ?min:float -> ?max:float -> float tyval int : ?min:int -> ?max:int -> int tyval int32 : ?min:int32 -> ?max:int32 -> int32 tyval int64 : ?min:int64 -> ?max:int64 -> int64 tyval string : ?min_length:int -> ?max_length:int -> string tyval unix_tm : ?min:Unix.tm -> ?max:Unix.tm -> Unix.tm tyThis can parse strings with the formats 2024-01-01 or 2024-01-01T00:00:00 into a timestamp.
Note that this is not timezone-aware.
Forms and fields
The type of a form (a form field by itself is also considered a form) which can decode values of type 'a or fail with a list of error message keys.
val ok : 'a -> 'a tok value is a form field that always successfully returns value.
val error : string -> string -> 'a terror name message is a form field that always errors the field name with the message.
These allow adding adding further checks to the entire form using all decoded field values and then attaching more errors to specific fields (or not).
list ?min_length ?max_length ty name is a form field which can decode a list of values which can each be decoded by ty. The list must have at least min_length and at most max_length (inclusive).
optional ty name is a form field which can decode an optional value from the form.
required ?default ty name is a form field which can decode a required value from the form. If at least one value corresponding to the given name does not appear in the form, and if a default value is not specified, the decoding fails with an error.
multiple n form is a form which can decode a list of nested form values. It tries to decode exactly n values and fails if it can't find all of them. Assumes that the items are 0-indexed. See Multiple structured values for a complete example.
val ensure :
string ->
('b -> bool) ->
('a ty -> string -> 'b t) ->
@@ -10,39 +10,44 @@
...However, note that let* uses a 'fail-fast' decoding strategy. If there is a decoding error, it immediately returns the error without decoding the subsequent fields. (Which makes sense if you think about the example above.) So, in order to ensure complete error reporting for all fields, you would need to use let+ and and+.
let+ email = required string "email" decodes a form field named email as a string.
and+ password = required string "password" continues decoding in an existing form declaration and decodes a form field password as a string.
val validate :
'a t ->
(string * string) list ->
- ('a, (string * string) list) Stdlib.resultvalidate form values is a result of validating the given form's values. It may be either some value of type 'a or a list of form field names and the corresponding error message keys.
pp_error is a helper pretty-printer for debugging/troubleshooting form validation errors.
Error keys
When errors are reported, the following keys are used instead of English strings. These keys can be used for localizing the error messages. The suggested default English translations are given below.
These keys are modelled after Play Framework.
Examples
Basic functionality
type user = { name : string; age : int option }
+ ('a, (string * string) list) Stdlib.result
validate form values is a result of validating the given form's values. It may be either some value of type 'a or a list of form field names and the corresponding error message keys.
pp_error is a helper pretty-printer for debugging/troubleshooting form validation errors.
When errors are reported, the following keys are used instead of English strings. These keys can be used for localizing the error messages. The suggested default English translations are given below.
These keys are modelled after Play Framework.
type user =
+ { name : string;
+ age : int option
+ }
open Dream_html.Form
let user_form =
let+ name = required string "name"
- and+ age = optional (int ~min:16) "age" in (* Thanks, Australia! *)
+ and+ age = optional (int ~min:16) "age" in
+ (* Thanks, Australia! *)
{ name; age }
let dream_form = ["age", "42"; "name", "Bob"]
-let user_result = validate user_form dream_formResult: Ok { name = "Bob"; age = Some 42 }
Sad path:
validate user_form ["age", "none"]Result: Error [("age", "error.expected.int"); ("name", "error.required")]
type plan = { id : string; features : string list }
+let user_result = validate user_form dream_formResult: Ok { name = "Bob"; age = Some 42 }
Sad path:
validate user_form ["age", "none"]Result: Error [("age", "error.expected.int"); ("name", "error.required")]
type plan =
+ { id : string;
+ features : string list
+ }
let plan_form =
let+ id = required string "id"
and+ features = list string "features" in
- { id; features }
-
-validate plan_form ["id", "foo"]Result: Ok {id = "foo"; features = []}
validate plan_form ["id", "foo"; "features", "f1"; "features", "f2"]Result: Ok {id = "foo"; features = ["f1"; "f2"]}
Note that the names can be anything, eg "features[]" if you prefer.
let plan_form =
- let+ id = ensure "error.expected.nonempty" (( <> ) "") required string "id"
+ { id; features } validate plan_form ["id", "foo"]Result: Ok {id = "foo"; features = []}
validate plan_form ["id", "foo"; "features", "f1"; "features", "f2"]Result: Ok {id = "foo"; features = ["f1"; "f2"]}
Note that the names can be anything, eg "features[]" if you prefer.
let plan_form =
+ let+ id =
+ ensure "error.expected.nonempty" (( <> ) "") required string "id"
and+ features = list string "features" in
- { id; features }
-
-validate plan_form ["id", ""]Result: Error [("id", "error.expected.nonempty")]
Using chained validation rules where some fields depend on others:
type req = {
- id : string;
- years : int option;
- months : int option;
- weeks : int option;
- days : int option;
-}
+ { id; features } validate plan_form ["id", ""]Result: Error [("id", "error.expected.nonempty")]
Using chained validation rules where some fields depend on others:
type req =
+ { id : string;
+ years : int option;
+ months : int option;
+ weeks : int option;
+ days : int option
+ }
let req_form =
let+ id = required string "id" (* Both id... *)
- and+ days, weeks, months, years = (* ...and period are required *)
+ and+ days, weeks, months, years =
+ (* ...and period are required *)
let* days = optional int "days" in
let* weeks = optional int "weeks" in
let* months = optional int "months" in
@@ -52,15 +57,21 @@
(* Only one period component is required *)
| _ -> ok (days, weeks, months, years)
in
- { id; days; weeks; months; years }
-
-validate req []Result: Error [("years", "Please enter a period"); ("id", "error.required")]
Suppose you have the following form data submitted:
item-count: 2
+ { id; days; weeks; months; years } validate req []Result: Error [("years", "Please enter a period"); ("id", "error.required")]
Suppose you have the following form data submitted:
item-count: 2
item[0].id: abc
item[0].qty: 1
item[1].id: def
item[1].qty: 10
-item[1].discount: 25And you want to decode it into the following types:
type item = { id : string; qty : int; discount : int }
-type invoice = { item_count : int; items : item list }First create the indexed invoice item decoder and invoice decoder:
let item n =
+item[1].discount: 25And you want to decode it into the following types:
type item =
+ { id : string;
+ qty : int;
+ discount : int
+ }
+
+type invoice =
+ { item_count : int;
+ items : item list
+ }First create the indexed invoice item decoder and invoice decoder:
let item n =
let nth name = "item[" ^ string_of_int n ^ "]." ^ name in
let+ id = required string (nth "id")
and+ qty = required int (nth "qty")
@@ -70,20 +81,21 @@
let invoice =
let* item_count = required int "item-count" in
let+ items = multiple item_count item in
- { item_count; items }Try it:
validate invoice [
- "item[0].id", "abc"; "item[0].qty", "1";
- "item[1].id", "def"; "item[1].qty", "10"; "item[1].discount", "25";
- "item-count", "2";
-]Result:
Ok {
- item_count = 2;
- items = [
- {id = "def"; qty = 10; discount = 25};
- {id = "abc"; qty = 1; discount = 0};
- ];
-}Validation error:
validate invoice [
- "item[0].qty", "1";
- "item[1].id", "def"; "item[1].discount", "25";
- "item-count", "2";
-]
-
-Error [item[0].id, error.required; item[1].qty, error.required]Try it:
validate invoice
+ [ "item[0].id", "abc";
+ "item[0].qty", "1";
+ "item[1].id", "def";
+ "item[1].qty", "10";
+ "item[1].discount", "25";
+ "item-count", "2" ]Result:
Ok
+ { item_count = 2;
+ items =
+ [ { id = "def"; qty = 10; discount = 25 };
+ { id = "abc"; qty = 1; discount = 0 } ]
+ }Validation error:
validate invoice
+ [ "item[0].qty", "1";
+ "item[1].id", "def";
+ "item[1].discount", "25";
+ "item-count", "2" ]
+ Error
+ [item [0].id, error.required; item [1].qty, error.required]Dream_html.HTMLAll standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []Or plain strings:
p [id "toast"] []Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div [contenteditable true] [
- p [] [txt "Edit me!"];
- p [contenteditable false] [txt "Can't edit me!"];
-]Enumerated attributes accept specific values:
input [inputmode `tel]val null_ : attrAn attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p [if should_show then null_ else style_ "display:none"] [txt "Show and tell"]val accept : _ string_attrval accept_charset : _ string_attrval accesskey : _ string_attrval action : _ string_attrval align : _ string_attrval allow : _ string_attrval alt : _ string_attrval as_ : _ string_attrval async : attrval autocapitalize :
+HTML (dream-html.Dream_html.HTML) Module Dream_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div
+ [contenteditable true]
+ [ p [] [txt "Edit me!"];
+ p [contenteditable false] [txt "Can't edit me!"] ]
Enumerated attributes accept specific values:
input [inputmode `tel]
val null_ : attrAn attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p
+ [(if should_show then null_ else style_ "display:none")]
+ [txt "Show and tell"]
val accept : _ string_attrval accept_charset : _ string_attrval accesskey : _ string_attrval action : _ string_attrval align : _ string_attrval allow : _ string_attrval alt : _ string_attrval as_ : _ string_attrval async : attrval autocapitalize :
[< `off | `none | `on | `sentences | `words | `characters ] to_attrval autocomplete :
[< `off
| `on
@@ -64,10 +66,10 @@
| `default_style
| `x_ua_compatible
| `refresh ]
- to_attrval id : _ string_attrval integrity : _ string_attrval inputmode :
+ to_attrval id : _ string_attrval inert : attrval integrity : _ string_attrval inputmode :
[< `none | `text | `decimal | `numeric | `tel | `search | `email | `url ]
to_attrval ismap : attrval itemprop : _ string_attrval kind :
- [< `subtitles | `captions | `descriptions | `chapters | `metadata ] to_attrval label_ : _ string_attrval lang : _ string_attrval list : _ string_attrval loading_lazy : attrSee https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading. loading=eager is the default so no need for specifically that value.
val loop : attrval low : float to_attrval max : _ string_attrval maxlength : int to_attrval media : _ string_attrval min : _ string_attrval minlength : int to_attrval multiple : attrval muted : attrval name : _ string_attrval novalidate : attrval onblur : _ string_attrNote that the value of this attribute is not escaped.
val onclick : _ string_attrNote that the value of this attribute is not escaped.
val open_ : attrval optimum : float to_attrval pattern : _ string_attrval ping : _ string_attrval placeholder : _ string_attrval playsinline : attrval poster : _ string_attrval preload : [< `none | `metadata | `auto ] to_attrval readonly : attrval referrerpolicy :
+ [< `subtitles | `captions | `descriptions | `chapters | `metadata ] to_attrval label_ : _ string_attrval lang : _ string_attrval list : _ string_attrval loading_lazy : attrSee https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading. loading=eager is the default so no need for specifically that value.
val loop : attrval low : float to_attrval max : _ string_attrval maxlength : int to_attrval media : _ string_attrval min : _ string_attrval minlength : int to_attrval multiple : attrval muted : attrval name : _ string_attrval novalidate : attrval onblur : _ string_attrNote that the value of this attribute is not escaped.
val onclick : _ string_attrNote that the value of this attribute is not escaped.
val open_ : attrval optimum : float to_attrval pattern : _ string_attrval ping : _ string_attrval placeholder : _ string_attrval playsinline : attrval popover : [< `auto | `manual ] to_attrval popovertarget : _ string_attrval popovertargetaction : [< `hide | `show ] to_attrtoggle is the default.
val poster : _ string_attrval preload : [< `none | `metadata | `auto ] to_attrval readonly : attrval referrerpolicy :
[< `no_referrer
| `no_referrer_when_downgrade
| `origin
@@ -150,12 +152,11 @@
| `tree
| `treegrid
| `treeitem ]
- to_attrval rows : int to_attrval rowspan : int to_attrval sandbox : _ string_attrval scope : _ string_attrval selected : attrval shape : _ string_attrval size : _ string_attrval sizes : _ string_attrval slot_ : _ string_attrval span_ : int to_attrval spellcheck : bool to_attrval src : _ string_attrval srcdoc : _ string_attrval srclang : _ string_attrval srcset : _ string_attrval start : int to_attrval step : _ string_attrval style_ : _ string_attrNote that the value of this attribute is not escaped.
val tabindex : int to_attrval target : _ string_attrval title_ : _ string_attrval translate : [< `yes | `no ] to_attrval type_ : _ string_attrNote: this can't be restricted to just the allowed values for <input type>, because it's used in other elements e.g. <link type>.
val usemap : _ string_attrval value : _ string_attrval width : _ string_attrval wrap : [< `hard | `soft ] to_attrTags
HTML tags. Most (standard tags) are constructed by passing a list of attributes and a list of children:
div [id "my-div"] [p [] [txt "Hello"]]
Some (void elements) are constructed only with a list of attributes:
input [required; type_ "email"; name "email-addr"]
Finally, a few (text elements) are constructed with a list of attributes and a single format string child:
title [] "Document title"
-
-title [] "My App ・ %s" page_name
-
-script [] {|alert('Careful, this is not escaped :-)');|}
A tag that will not be rendered in the markup. Useful for containing a bunch of child nodes inside a single node without having to litter the DOM with an actual node. Also may be called 'splicing'.
null [
- p [] [txt "This paragraph."];
- p [] [txt "And this paragraph."];
- p [] [txt "Are spliced directly into the document without a containing node."];
-]
Also useful for constructing a completely empty node that is erased when printing:
null []
val a : std_tagval address : std_tagval area : void_tagval abbr : std_tagval article : std_tagval aside : std_tagval audio : std_tagval b : std_tagval base : void_tagval bdi : std_tagval bdo : std_tagval blockquote : std_tagval body : std_tagval br : void_tagval button : std_tagval canvas : std_tagval caption : std_tagval cite : std_tagval code : std_tagval col : void_tagval colgroup : std_tagval data : std_tagval datalist : std_tagval dd : std_tagval del : std_tagval details : std_tagval dfn : std_tagval dialog : std_tagval div : std_tagval dl : std_tagval dt : std_tagval em : std_tagval embed : void_tagval fieldset : std_tagval figcaption : std_tagval figure : std_tagval form : std_tagval h1 : std_tagval h2 : std_tagval h3 : std_tagval h4 : std_tagval h5 : std_tagval h6 : std_tagval head : std_tagval header : std_tagval hgroup : std_tagval hr : void_tagval html : std_tagA <!DOCTYPE html> declaration is automatically prefixed when this tag is printed.
val i : std_tagval iframe : std_tagval img : void_tagval input : void_tagval ins : std_tagval kbd : std_tagval label : std_tagval legend : std_tagval li : std_tagval link : void_tagval main : std_tagval map : std_tagval mark : std_tagval meta : void_tagval meter : std_tagval noscript : std_tagval object_ : std_tagval ol : std_tagval optgroup : std_tagval option : _ text_tagval output : std_tagval p : std_tagval picture : std_tagval pre : std_tagval progress : std_tagval q : std_tagval rp : std_tagval rt : std_tagval ruby : std_tagval s : std_tagval samp : std_tagval script : _ text_tagNote that the content of this tag is not escaped.
val section : std_tagval select : std_tagval slot : std_tagval small : std_tagval source : void_tagval span : std_tagval strong : std_tagval style : _ text_tagNote that the content of this tag is not escaped.
val sub : std_tagval summary : std_tagval sup : std_tagval table : std_tagval tbody : std_tagval td : std_tagval template : std_tagval textarea : _ text_tagval tfoot : std_tagval th : std_tagval thead : std_tagval time : std_tagval title : _ text_tagval tr : std_tagval track : void_tagval u : std_tagval ul : std_tagval var : std_tagval video : std_tagval wbr : void_tag
+ to_attrval rows : int to_attrval rowspan : int to_attrval sandbox : _ string_attrval scope : _ string_attrval selected : attrval shadowrootclonable : attrval shadowrootdelegatesfocus : attrval shadowrootmode : [ `open_ | `closed ] to_attrval shape : _ string_attrval size : _ string_attrval sizes : _ string_attrval slot_ : _ string_attrval span_ : int to_attrval spellcheck : bool to_attrval src : _ string_attrval srcdoc : _ string_attrval srclang : _ string_attrval srcset : _ string_attrval start : int to_attrval step : _ string_attrval style_ : _ string_attrNote that the value of this attribute is not escaped.
val tabindex : int to_attrval target : _ string_attrval title_ : _ string_attrval translate : [< `yes | `no ] to_attrval type_ : _ string_attrNote: this can't be restricted to just the allowed values for <input type>, because it's used in other elements e.g. <link type>.
val usemap : _ string_attrval value : _ string_attrval width : _ string_attrval wrap : [< `hard | `soft ] to_attrHTML tags. Most (standard tags) are constructed by passing a list of attributes and a list of children:
div [id "my-div"] [p [] [txt "Hello"]]Some (void elements) are constructed only with a list of attributes:
input [required; type_ "email"; name "email-addr"]Finally, a few (text elements) are constructed with a list of attributes and a single format string child:
title [] "Document title" title [] "My App ・ %s" page_name script []
+ {|alert('Careful, this is not escaped :-)');|}A tag that will not be rendered in the markup. Useful for containing a bunch of child nodes inside a single node without having to litter the DOM with an actual node. Also may be called 'splicing'.
null
+ [ p [] [txt "This paragraph."];
+ p [] [txt "And this paragraph."];
+ p []
+ [ txt
+ "Are spliced directly into the document without a containing node."
+ ] ]Also useful for constructing a completely empty node that is erased when printing: null [].
val a : std_tagval address : std_tagval area : void_tagval abbr : std_tagval article : std_tagval aside : std_tagval audio : std_tagval b : std_tagval base : void_tagval bdi : std_tagval bdo : std_tagval blockquote : std_tagval body : std_tagval br : void_tagval button : std_tagval canvas : std_tagval caption : std_tagval cite : std_tagval code : std_tagval col : void_tagval colgroup : std_tagval data : std_tagval datalist : std_tagval dd : std_tagval del : std_tagval details : std_tagval dfn : std_tagval dialog : std_tagval div : std_tagval dl : std_tagval dt : std_tagval em : std_tagval embed : void_tagval fieldset : std_tagval figcaption : std_tagval figure : std_tagval form : std_tagval h1 : std_tagval h2 : std_tagval h3 : std_tagval h4 : std_tagval h5 : std_tagval h6 : std_tagval head : std_tagval header : std_tagval hgroup : std_tagval hr : void_tagval html : std_tagA <!DOCTYPE html> declaration is automatically prefixed when this tag is printed.
val i : std_tagval iframe : std_tagval img : void_tagval input : void_tagval ins : std_tagval kbd : std_tagval label : std_tagval legend : std_tagval li : std_tagval link : void_tagval main : std_tagval map : std_tagval mark : std_tagval meta : void_tagval meter : std_tagval noscript : std_tagval object_ : std_tagval ol : std_tagval optgroup : std_tagval option : _ text_tagval output : std_tagval p : std_tagval picture : std_tagval pre : std_tagval progress : std_tagval q : std_tagval rp : std_tagval rt : std_tagval ruby : std_tagval s : std_tagval samp : std_tagval script : _ text_tagNote that the content of this tag is not escaped.
val search : std_tagval section : std_tagval select : std_tagval selectedoption : std_tagval slot : std_tagval small : std_tagval source : void_tagval span : std_tagval strong : std_tagval style : _ text_tagNote that the content of this tag is not escaped.
val sub : std_tagval summary : std_tagval sup : std_tagval table : std_tagval tbody : std_tagval td : std_tagval template : std_tagval textarea : _ text_tagval tfoot : std_tagval th : std_tagval thead : std_tagval time : std_tagval title : _ text_tagval tr : std_tagval track : void_tagval u : std_tagval ul : std_tagval var : std_tagval video : std_tagval wbr : void_tagDream_html.Hxhtmx support
The attributes in this module are arranged in the same order as on the reference page linked above.
Remember that you will also need the htmx script itself. The recommended way to get it is to download a copy and place it in your static assets directory, managed by dreamwork so that it is properly cached and version-hashed by its contents.
val get : _ string_attrval post : _ string_attrval on_ : event:string -> _ string_attrThe hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
val push_url : _ string_attrval select : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val target : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attrNote that the value of this attribute is not escaped.
val vals : _ string_attrval boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disabled_elt : _ string_attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval headers : _ string_attrval history_false : attrHardcoding of the hx-history attribute to false.
val history_elt : attrval include_ : _ string_attrval indicator : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attrval params : _ string_attrval patch : _ string_attrval preserve : attrval prompt : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ string_attrval sync : _ string_attrval validate : attrval preload : attrThe preload extension: https://htmx.org/extensions/preload/
val sse_close : _ string_attrval sse_connect : _ string_attrval sse_swap : _ string_attrval ws_connect : _ string_attrval ws_send : attrval __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val on : _ string_attrNote that the value of this attribute is not escaped.
Dream_html.Hxhtmx support
The attributes in this module are arranged in the same order as on the reference page linked above.
Remember that you will also need the htmx script itself. The recommended way to get it is to download a copy and place it in your static assets directory, managed by dreamwork so that it is properly cached and version-hashed by its contents.
val get : _ string_attrval post : _ string_attrval on_ : event:string -> _ string_attrThe hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
val push_url : _ string_attrval select : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val target : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attrNote that the value of this attribute is not escaped.
val vals : _ string_attrval boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disabled_elt : _ string_attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval headers : _ string_attrval history_false : attrHardcoding of the hx-history attribute to false.
val history_elt : attrval include_ : _ string_attrval indicator : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attrval params : _ string_attrval patch : _ string_attrval preserve : attrval prompt : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ string_attrval sync : _ string_attrval validate : attrval preload : attrThe preload extension: https://htmx.org/extensions/preload/
val sse_close : _ string_attrval sse_connect : _ string_attrval sse_swap : _ string_attrval ws_connect : _ string_attrval ws_send : attrval __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val on : _ string_attrNote that the value of this attribute is not escaped.
Dream_html.LivereloadLive reload script injection and handling. Adapted from Dream.livereload middleware. This version is not a middleware so it's not as plug-and-play as that, but on the other hand it's much simpler to implement because it uses type-safe dream-html nodes rather than parsing and printing raw HTML. See below for the 3-step process to use it.
This module is adapted from Dream, released under the MIT license. For details, visit https://github.com/aantron/dream.
Copyright 2021-2023 Thibaut Mattio, Anton Bachin.
(1) Put this in your top-level router:
let () =
+Livereload (dream-html.Dream_html.Livereload) Module Dream_html.Livereload
Live reload script injection and handling. Adapted from Dream.livereload middleware. This version is not a middleware so it's not as plug-and-play as that, but on the other hand it's much simpler to implement because it uses type-safe dream-html nodes rather than parsing and printing raw HTML. See below for the 3-step process to use it.
This module is adapted from Dream, released under the MIT license. For details, visit https://github.com/aantron/dream.
Copyright 2021-2023 Thibaut Mattio, Anton Bachin.
(1) Put this in your top-level router:
let () =
Dream.run
@@ Dream.logger
- @@ Dream.router [
- Dream_html.Livereload.route;
- (* ...other routes... *)
- ]
val script : node(2) Put this inside your head:
head [] [Livereload.script (* ... *)]
(3) And run the server with environment variable LIVERELOAD=1.
⚠️ If this env var is not set, then livereload is turned off. This means that the route will respond with 404 status and the script will be omitted from the rendered HTML.
+ @@ Dream.router [Dream_html.Livereload.route (* ...other routes... *)]val script : node(2) Put this inside your head:
head [] [Livereload.script (* ... *)](3) And run the server with environment variable LIVERELOAD=1.
⚠️ If this env var is not set, then livereload is turned off. This means that the route will respond with 404 status and the script will be omitted from the rendered HTML.
Dream_html.MathMLval accent : bool to_attrval accentunder : bool to_attrval columnspan : int to_attrval depth : _ string_attrval dir : [ `ltr | `rtl ] to_attrval display_block : attrSee https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attrval fence : bool to_attrval height : _ string_attrval largeop : bool to_attrval linethickness : _ string_attrval lspace : _ string_attrval mathvariant : _ string_attrval maxsize : _ string_attrval minsize : _ string_attrval movablelimits : bool to_attrval rowspan : int to_attrval rspace : _ string_attrval scriptlevel : _ string_attrval separator : bool to_attrval stretchy : bool to_attrval symmetric : bool to_attrval voffset : _ string_attrval xmlns : attrval annotation : std_tagval annotation_xml : std_tagval math : std_tagval merror : std_tagval mfrac : std_tagval mi : std_tagval mmultiscripts : std_tagval mn : std_tagval mo : std_tagval mover : std_tagval mpadded : std_tagval mphantom : std_tagval mroot : std_tagval mrow : std_tagval ms : std_tagval mspace : std_tagval msqrt : std_tagval mstyle : std_tagval msub : std_tagval msubsup : std_tagval msup : std_tagval mtable : std_tagval mtd : std_tagval mtext : std_tagval mtr : std_tagval munder : std_tagval munderover : std_tagval semantics : std_tagDream_html.MathMLval accent : bool to_attrval accentunder : bool to_attrval columnspan : int to_attrval depth : _ string_attrval dir : [ `ltr | `rtl ] to_attrval display_block : attrSee https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attrval fence : bool to_attrval height : _ string_attrval largeop : bool to_attrval linethickness : _ string_attrval lspace : _ string_attrval mathvariant : _ string_attrval maxsize : _ string_attrval minsize : _ string_attrval movablelimits : bool to_attrval rowspan : int to_attrval rspace : _ string_attrval scriptlevel : _ string_attrval separator : bool to_attrval stretchy : bool to_attrval symmetric : bool to_attrval voffset : _ string_attrval xmlns : attrval annotation : std_tagval annotation_xml : std_tagval math : std_tagval merror : std_tagval mfrac : std_tagval mi : std_tagval mmultiscripts : std_tagval mn : std_tagval mo : std_tagval mover : std_tagval mpadded : std_tagval mphantom : std_tagval mroot : std_tagval mrow : std_tagval ms : std_tagval mspace : std_tagval msqrt : std_tagval mstyle : std_tagval msub : std_tagval msubsup : std_tagval msup : std_tagval mtable : std_tagval mtd : std_tagval mtext : std_tagval mtr : std_tagval munder : std_tagval munderover : std_tagval semantics : std_tagDream_html.RSSRSS support
val domain : _ string_attrval version_2 : attrval xmlns_atom : attrval author : _ text_tagval channel : std_tagval category : _ text_tagval comments : _ text_tagval copyright : _ text_tagval description : _ text_tagval docs : _ text_tagval generator : _ text_tagval guid : _ text_tagval item : std_tagval language : _ text_tagval last_build_date : _ text_tagval link : _ text_tagval managing_editor : _ text_tagval pub_date : _ text_tagval rss : std_tagval title : _ text_tagval ttl : _ text_tagval web_master : _ text_tagDream_html.RSSRSS support
val domain : _ string_attrval length : int to_attrval path : _ string_attrval port : int to_attrval protocol : _ string_attrval register_procedure : _ string_attrval type_ : _ string_attrval url_ : _ string_attrval version_2 : attrval author : _ text_tagval channel : std_tagval category : _ text_tagval cloud : void_tagval comments : _ text_tagval copyright : _ text_tagval description : _ text_tagval docs : _ text_tagval enclosure : std_tagval generator : _ text_tagval guid : _ text_tagval height : _ text_tagval image : std_tagval item : std_tagval language : _ text_tagval last_build_date : _ text_tagval link : _ text_tagval managing_editor : _ text_tagval pub_date : _ text_tagval rss : std_tagval title : _ text_tagval ttl : _ text_tagval url : _ text_tagval web_master : _ text_tagval width : _ text_tagDream_html.SVGval d : _ string_attrval fill : _ string_attrval stroke : _ string_attrval stroke_linecap : [< `butt | `round | `square ] to_attrval stroke_linejoin :
+SVG (dream-html.Dream_html.SVG) Module Dream_html.SVG
val d : _ string_attrval fill : _ string_attrval stroke : _ string_attrval stroke_linecap : [< `butt | `round | `square ] to_attrval stroke_linejoin :
[< `arcs | `bevel | `miter | `miter_clip | `round ] to_attrval stroke_width : _ string_attrval viewbox : min_x:int -> min_y:int -> width:int -> height:int -> attrval xmlns : attrval path : std_tagval svg : std_tag
diff --git a/dream-html/Dream_html/index.html b/dream-html/Dream_html/index.html
index 5ddb33a..706ca02 100644
--- a/dream-html/Dream_html/index.html
+++ b/dream-html/Dream_html/index.html
@@ -1,5 +1,5 @@
-Dream_html (dream-html.Dream_html) Module Dream_html
Form handling
module Form : sig ... endTyped, extensible HTML form decoder with error reporting for form field validation failures. Powerful chained decoding functionality–the validation of one field can depend on the values of other decoded fields.
val form :
+Dream_html (dream-html.Dream_html) Module Dream_html
Form handling
module Form : sig ... endTyped, extensible HTML form decoder with error reporting for form field validation failures. Powerful chained decoding functionality–the validation of one field can depend on the values of other decoded fields.
val form :
'a Form.t ->
?csrf:bool ->
Dream.request ->
@@ -24,7 +24,7 @@
a [href "/foo?a=1&b=2 3&c=4<5&d=6>5"] [txt "Test"]
==>
-<a href="/foo?a=1&b=2%203&c=4%3C5&d=6%3E5">Test</a>val bool_attr : string -> bool to_attrval float_attr : string -> float to_attrval int_attr : string -> int to_attrval std_tag : string -> std_tagval void_tag : string -> void_tagval text_tag : string -> ?raw:bool -> _ text_tagBuild a tag which can contain only text.
val uri_tag : string -> _ text_tagBuild a tag which can contain only a URI. The URI is scaped with the same rules as a uri_attr.
val txt : ?raw:bool -> ('a, unit, string, node) Stdlib.format4 -> 'aA text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:
b [] [txt "Hello, %s!" name]
Or without interpolation:
b [] [txt "Bold of you."]
HTML-escapes the text value. You can use the ~raw param to bypass escaping:
let user_input = "<script>alert('I like HTML injection')</script>" in
+<a href="/foo?a=1&b=2%203&c=4%3C5&d=6%3E5">Test</a>
val bool_attr : string -> bool to_attrval float_attr : string -> float to_attrval int_attr : string -> int to_attrval std_tag : string -> std_tagval void_tag : string -> void_tagval text_tag : string -> ?raw:bool -> _ text_tagBuild a tag which can contain only text.
val uri_tag : string -> _ text_tagBuild a tag which can contain only a URI. The URI is escaped with the same rules as a uri_attr.
val txt : ?raw:bool -> ('a, unit, string, node) Stdlib.format4 -> 'aA text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:
b [] [txt "Hello, %s!" name]
Or without interpolation:
b [] [txt "Bold of you."]
HTML-escapes the text value. You can use the ~raw param to bypass escaping:
let user_input = "<script>alert('I like HTML injection')</script>" in
txt ~raw:true "%s" user_input
val comment : string -> nodeA comment that will be embedded in the rendered HTML, i.e. <!-- comment -->. The text is HTML-escaped.
Accessors for tags
Add an attribute to a tag.
let toast msg = p [id "toast"] [txt "%s" msg]
let toast_oob = toast "ok." +@ Hx.swap_oob "true"
val (.@[]) : node -> string -> stringGet the value of an existing attribute.
let toast = p [id "toast"] [txt "OK."]
let toast_id = toast.@["id"]
val is_null : node -> boolGet whether a node is null (empty) or not. Useful for conditional rendering of UIs when you are passed in a node and you don't know if it's empty or not.
val is_null_ : attr -> boolGet whether an attribute is null (empty) or not.
HTML
module HTML : sig ... endAll standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
SVG
module SVG : sig ... endMathML
module MathML : sig ... endARIA
module Aria : sig ... endRSS and Atom
module Atom : sig ... endhtmx
val respond :
@@ -37,14 +37,12 @@
?end_of_message:[< Dream.end_of_message ] ->
Dream.websocket ->
node ->
- unit Dream.promiseType-safe wrapper for Dream.send.
val set_body : Dream.response -> node -> unitType-safe wrapper for Dream.set_body. Sets the body to the given node and sets the Content-Type header to text/html.
val write : Dream.stream -> node -> unit Dream.promiseType-safe wrapper for Dream.write.
val csrf_tag : Dream.request -> nodeConvenience to add a CSRF token generated by Dream into your form. Type-safe equivalent of Dream.csrf_tag.
form [action "/foo"] [
- csrf_tag req;
- input [name "bar"];
- input [type_ "submit"];
-]
Type-safe routing
Bidirectional paths with type-safe path segment parsing and printing using OCaml's built-in format strings, and fully plug-and-play compatible with Dream routes.
type ('r, 'p) route = ('r, 'p) path -> (Dream.request -> 'r) -> Dream.routeWrapper for a Dream route that represents the ability to parse path parameters and pass them to the handler function with the correct types.
val set_body : Dream.response -> node -> unitType-safe wrapper for Dream.set_body. Sets the body to the given node and sets the Content-Type header to text/html.
val write : Dream.stream -> node -> unit Dream.promiseType-safe wrapper for Dream.write.
val csrf_tag : Dream.request -> nodeConvenience to add a CSRF token generated by Dream into your form. Type-safe equivalent of Dream.csrf_tag.
form
+ [action "/foo"]
+ [csrf_tag req; input [name "bar"]; input [type_ "submit"]]
Type-safe routing
Bidirectional paths with type-safe path segment parsing and printing using OCaml's built-in format strings, and fully plug-and-play compatible with Dream routes.
type ('r, 'p) route = ('r, 'p) path -> (Dream.request -> 'r) -> Dream.routeWrapper for a Dream route that represents the ability to parse path parameters and pass them to the handler function with the correct types.
val path :
('r, unit, Dream.response Dream.promise) Stdlib.format ->
('p, unit, string, attr) Stdlib.format4 ->
- ('r, 'p) pathpath request_fmt attr_fmt is a router path. The dream-html.ppx provides a more convenient way.
Without PPX: let order = path "/orders/%s" "/orders/%s"
With PPX: let%path order = "/orders/%s"
Refer to the PPX documentation for instructions on using it.
⚠️ Due to the way Dream's router works, all parameter captures happens between / characters and the end of the path (or the ? character, whichever comes first). Eg, /foo/%s/bar/%d is valid, but /foo/%s.%s (note the dot character) is not a valid capture.
⚠️ If a route is matched but the data type does not match, a 400 Bad Request response will be returned. The following type conversion specs are supported:
%s capture a string and pass it to the handler
%*s capture the rest of the path and pass the captured length and string to the handler
%c capture a char
%d or %i capture an int
%x capture a hexadecimal int
%X capture an uppercase hexadecimal int
%o capture an octal int
%ld capture an int32
%Ld capture an int64
%f capture a float
%B capture a bool
⚠️ We are actually using Dream's built-in router, not our own, and Dream's router doesn't distinguish between parameter types. So, to Dream both /%s and /%d are the same path. It will route the request to whichever happens to be first in the route list, and that one will succeed or fail depending on its type and the request target.
val path_attr : 'p string_attr -> (_, 'p) path -> 'ppath_attr attr path is an HTML attribute with the path parameters filled in from the given values. Eg,
let%path order = "/orders/%s"
+ ('r, 'p) path
path request_fmt attr_fmt is a router path. The dream-html.ppx provides a more convenient way.
Without PPX: let order = path "/orders/%s" "/orders/%s"
With PPX: let%path order = "/orders/%s"
Refer to the PPX documentation for instructions on using it.
⚠️ Due to the way Dream's router works, all parameter captures happen between / characters and the end of the path (or the ? character, whichever comes first). Eg, /foo/%s/bar/%d is valid, but /foo/%s.%s (note the dot character) is not a valid capture.
⚠️ If a route is matched but the data type does not match, a 400 Bad Request response will be returned. The following type conversion specs are supported:
%s capture a string and pass it to the handler
%*s capture the rest of the path and pass the captured length and string to the handler
%c capture a char
%d or %i capture an int
%x capture a hexadecimal int
%X capture an uppercase hexadecimal int
%o capture an octal int
%ld capture an int32
%Ld capture an int64
%f capture a float
%B capture a bool
⚠️ We are actually using Dream's built-in router, not our own, and Dream's router doesn't distinguish between parameter types. So, to Dream both /%s and /%d are the same path. It will route the request to whichever happens to be first in the route list, and that one will succeed or fail depending on its type and the request target.
val path_attr : 'p string_attr -> (_, 'p) path -> 'ppath_attr attr path is an HTML attribute with the path parameters filled in from the given values. Eg,
let%path order = "/orders/%s"
open Dream_html
open HTML
@@ -55,13 +53,7 @@
...
a [path_attr href order order_id] [txt "Your order"]
...
-)
val post : (_, _) routeval put : (_, _) routeval delete : (_, _) routeval head : (_, _) routeval connect : (_, _) routeval options : (_, _) routeval trace : (_, _) routeval patch : (_, _) routeval any : (_, _) routeuse middlewares routes is a route that is composed of all the given routes with the middlewares attached to them.
val static_asset : (Dream.response Dream.promise, _) path -> Dream.routestatic_asset path is a route that handles serving the static file at the path. Importantly, it sets an immutable cache header which remains valid for a year.
⚠️ Be sure that the resource has a unique identifier because it will be cached immutably. The dreamwork CLI tool automates this for you. See Dreamwork.
Dreamwork
TL;DR:
- Run
dreamwork setup - Populate the
static/assets/ subdirectory with files - Run
dune build - Add
Static.routes to the app's main Dream router - Use eg
img [path_attr src Static.Assets.icon_png] which will render with a revision hash based on the file contents, calculated at build time
dreamwork is a CLI tool that helps set up and manage static file paths and routes with proper content-based version hashes. The static files will live inside a dune component called static and in the static/assets subdirectory. Suppose you have the following directory tree:
static/
- dune
- assets/
- css/
- app.css
- js/
- app.js
The dune file defines a library component that will make the following module available:
module Static : sig
+)
val post : (_, _) routeval put : (_, _) routeval delete : (_, _) routeval head : (_, _) routeval connect : (_, _) routeval options : (_, _) routeval trace : (_, _) routeval patch : (_, _) routeval any : (_, _) routeuse middlewares routes is a route that is composed of all the given routes with the middlewares attached to them.
val static_asset : (Dream.response Dream.promise, _) path -> Dream.routestatic_asset path is a route that handles serving the static file at the path. Importantly, it sets an immutable cache header which remains valid for a year.
⚠️ Be sure that the resource has a unique identifier because it will be cached immutably. The dreamwork CLI tool automates this for you. See Dreamwork.
Dreamwork
TL;DR:
- Run
dreamwork setup - Populate the
static/assets/ subdirectory with files - Run
dune build - Add
Static.routes to the app's main Dream router - Use eg
img [path_attr src Static.Assets.icon_png] which will render with a revision hash based on the file contents, calculated at build time
dreamwork is a CLI tool that helps set up and manage static file paths and routes with proper content-based version hashes. The static files will live inside a dune component called static and in the static/assets subdirectory. Suppose you have the following directory tree:
static / dune assets / css / app.css js / app.js
The dune file defines a library component that will make the following module available:
module Static : sig
val routes : Dream.route
(** This route will serve all of the following paths. *)
diff --git a/dream-html/Ppx/index.html b/dream-html/Ppx/index.html
index c8e3760..b4ac800 100644
--- a/dream-html/Ppx/index.html
+++ b/dream-html/Ppx/index.html
@@ -1,5 +1,5 @@
-Ppx (dream-html.Ppx) Module Ppx
This PPX provides an extension point to create route paths.
You can add it to your dune file in the usual way: (preprocess (pps dream-html.ppx)).
Then create a path: let%path orders = "/orders".
And use it in a route: Dream_html.get orders (fun req -> ...).
The PPX expands the above path to:
let orders = Dream_html.path "/orders" "/orders"
Ie, it just duplicates the path string to use as two separate format strings with different types for parsing and printing. If you need to actually have a different format string for printing (eg if you need to print the path with query parameters), you can use the underlying Dream_html.path function directly: path "/orders/%s" "/orders/%s?utm_src=%s&utm_campaign=%s".
The PPX also has the benefit that it checks that the path is well-formed at compile time. If you pass in an invalid path you get a compile error:
File "test/route_test.ml", line 1, characters 0-20:
+Ppx (dream-html.Ppx) Module Ppx
This PPX provides an extension point to create route paths.
You can add it to your dune file in the usual way: (preprocess (pps dream-html.ppx)).
Then create a path: let%path orders = "/orders".
And use it in a route: Dream_html.get orders (fun req -> ...).
The PPX expands the above path to:
let orders = Dream_html.path "/orders" "/orders"
Ie, it just duplicates the path string to use as two separate format strings with different types for parsing and printing. If you need to actually have a different format string for printing (eg if you need to print the path with query parameters), you can use the underlying Dream_html.path function directly: path "/orders/%s" "/orders/%s?utm_src=%s&utm_campaign=%s".
The PPX also has the benefit that it checks that the path is well-formed at compile time. If you pass in an invalid path you get a compile error:
File "test/route_test.ml", line 1, characters 0-20:
1 | let%path bad = "foo"
^^^^^^^^^^^^^^^^^^^^
Error: Invalid path: 'foo'. Paths must start with a '/' character
index (dream-html.index) dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.
Library dream-html.ppx
The entry point of this library is the module: Ppx.
+index (dream-html.index) dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.
Library dream-html.ppx
The entry point of this library is the module: Ppx.
diff --git a/odoc.support/odoc.css b/odoc.support/odoc.css
index 15240b5..f0f22a1 100644
--- a/odoc.support/odoc.css
+++ b/odoc.support/odoc.css
@@ -1,7 +1,7 @@
@charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
- odoc 2.4.3 */
+ odoc 2.4.4 */
/* Fonts */
/* noticia-text-regular - latin */
diff --git a/pure-html/Pure_html/Aria/index.html b/pure-html/Pure_html/Aria/index.html
index 0347fd1..bb4017d 100644
--- a/pure-html/Pure_html/Aria/index.html
+++ b/pure-html/Pure_html/Aria/index.html
@@ -1,2 +1,2 @@
-Aria (pure-html.Pure_html.Aria) Module Pure_html.Aria
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
val activedescendant : _ string_attrval atomic : attrval autocomplete : [ `inline | `list | `both ] to_attrval braillelabel : _ string_attrval brailleroledescription : _ string_attrval busy : attrval checked : [ `false_ | `true_ | `mixed ] to_attrval colcount : int to_attrval colindextext : _ string_attrval colspan : int to_attrval controls : _ string_attrval current : [ `page | `step | `location | `date | `time | `true_ ] to_attrval describedby : _ string_attrval description : _ string_attrval details : _ string_attrval disabled : attrval errormessage : _ string_attrval expanded : bool to_attrval flowto : _ string_attrval haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attrval invalid : [ `grammar | `spelling | `true_ ] to_attrval keyshortcuts : _ string_attrval label : _ string_attrval labelledby : _ string_attrval level : int to_attrval live : [ `assertive | `off | `polite ] to_attr⚠️ Screen readers want a live region to be defined statically from page load on a visible element, eg p [id "toast"; Aria.live `polite] []. The element must not be hidden initially, otherwise the screen reader will continue to ignore it even when its content is changed.
val modal : attrval multiline : attrval multiselectable : attrval orientation : [ `horizontal | `vertical ] to_attrval owns : _ string_attrval placeholder : _ string_attrval posinset : int to_attrval pressed : [ `false_ | `mixed | `true_ ] to_attrval readonly : attrval relevant : [ `additions | `all | `removals | `text ] to_attrval required : attrval roledescription : _ string_attrval rowcount : int to_attrval rowindex : int to_attrval rowindextext : _ string_attrval rowspan : int to_attrval selected : bool to_attrval setsize : int to_attrval sort : [ `ascending | `descending | `other ] to_attrval valuemax : float to_attrval valuemin : float to_attrval valuenow : float to_attrval valuetext : _ string_attr
+Aria (pure-html.Pure_html.Aria) Module Pure_html.Aria
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/
val activedescendant : _ string_attrval atomic : attrval autocomplete : [ `inline | `list | `both ] to_attrval braillelabel : _ string_attrval brailleroledescription : _ string_attrval busy : attrval checked : [ `false_ | `true_ | `mixed ] to_attrval colcount : int to_attrval colindextext : _ string_attrval colspan : int to_attrval controls : _ string_attrval current : [ `page | `step | `location | `date | `time | `true_ ] to_attrval describedby : _ string_attrval description : _ string_attrval details : _ string_attrval disabled : attrval errormessage : _ string_attrval expanded : bool to_attrval flowto : _ string_attrval haspopup : [ `true_ | `menu | `listbox | `tree | `grid | `dialog ] to_attrval invalid : [ `grammar | `spelling | `true_ ] to_attrval keyshortcuts : _ string_attrval label : _ string_attrval labelledby : _ string_attrval level : int to_attrval live : [ `assertive | `off | `polite ] to_attr⚠️ Screen readers want a live region to be defined statically from page load on a visible element, eg p [id "toast"; Aria.live `polite] []. The element must not be hidden initially, otherwise the screen reader will continue to ignore it even when its content is changed.
`off since 3.10.0
val modal : attrval multiline : attrval multiselectable : attrval orientation : [ `horizontal | `vertical ] to_attrval owns : _ string_attrval placeholder : _ string_attrval posinset : int to_attrval pressed : [ `false_ | `mixed | `true_ ] to_attrval readonly : attrval relevant : [ `additions | `all | `removals | `text ] to_attrval required : attrval roledescription : _ string_attrval rowcount : int to_attrval rowindex : int to_attrval rowindextext : _ string_attrval rowspan : int to_attrval selected : bool to_attrval setsize : int to_attrval sort : [ `ascending | `descending | `other ] to_attrval valuemax : float to_attrval valuemin : float to_attrval valuenow : float to_attrval valuetext : _ string_attr
diff --git a/pure-html/Pure_html/Atom/index.html b/pure-html/Pure_html/Atom/index.html
index 41a7c15..097f710 100644
--- a/pure-html/Pure_html/Atom/index.html
+++ b/pure-html/Pure_html/Atom/index.html
@@ -1,2 +1,2 @@
-Atom (pure-html.Pure_html.Atom) Module Pure_html.Atom
val link : std_tag
+Atom (pure-html.Pure_html.Atom) Module Pure_html.Atom
HTML (pure-html.Pure_html.HTML) Module Pure_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div [contenteditable true] [
- p [] [txt "Edit me!"];
- p [contenteditable false] [txt "Can't edit me!"];
-]
Enumerated attributes accept specific values:
input [inputmode `tel]
val null_ : attrAn attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p [if should_show then null_ else style_ "display:none"] [txt "Show and tell"]
val accept : _ string_attrval accept_charset : _ string_attrval accesskey : _ string_attrval action : _ string_attrval align : _ string_attrval allow : _ string_attrval alt : _ string_attrval as_ : _ string_attrval async : attrval autocapitalize :
+HTML (pure-html.Pure_html.HTML) Module Pure_html.HTML
All standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
Attributes
Standard, most non-deprecated attributes from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes. Where an attribute name conflicts with an OCaml keyword, the name is suffixed with _. Most attributes are constructed by passing in a value of some type.
All string-valued attributes allow formatting (interpolation):
div [id "section-%d" section_id] []
Or plain strings:
p [id "toast"] []
Most boolean attributes are plain values and don't need to be constructed with function calls:
input [required]
However, boolean attributes which may be inherited and toggled on/off in children, are constructed by passing in a value:
div
+ [contenteditable true]
+ [ p [] [txt "Edit me!"];
+ p [contenteditable false] [txt "Can't edit me!"] ]
Enumerated attributes accept specific values:
input [inputmode `tel]
val null_ : attrAn attribute that will not be rendered in the markup. Useful for conditional logic where you sometimes want to render an attribute and sometimes not.
p
+ [(if should_show then null_ else style_ "display:none")]
+ [txt "Show and tell"]
val accept : _ string_attrval accept_charset : _ string_attrval accesskey : _ string_attrval action : _ string_attrval align : _ string_attrval allow : _ string_attrval alt : _ string_attrval as_ : _ string_attrval async : attrval autocapitalize :
[< `off | `none | `on | `sentences | `words | `characters ] to_attrval autocomplete :
[< `off
| `on
@@ -64,10 +66,10 @@
| `default_style
| `x_ua_compatible
| `refresh ]
- to_attrval id : _ string_attrval integrity : _ string_attrval inputmode :
+ to_attrval id : _ string_attrval inert : attrval integrity : _ string_attrval inputmode :
[< `none | `text | `decimal | `numeric | `tel | `search | `email | `url ]
to_attrval ismap : attrval itemprop : _ string_attrval kind :
- [< `subtitles | `captions | `descriptions | `chapters | `metadata ] to_attrval label_ : _ string_attrval lang : _ string_attrval list : _ string_attrval loading_lazy : attrSee https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading. loading=eager is the default so no need for specifically that value.
val loop : attrval low : float to_attrval max : _ string_attrval maxlength : int to_attrval media : _ string_attrval min : _ string_attrval minlength : int to_attrval multiple : attrval muted : attrval name : _ string_attrval novalidate : attrval onblur : _ string_attrNote that the value of this attribute is not escaped.
val onclick : _ string_attrNote that the value of this attribute is not escaped.
val open_ : attrval optimum : float to_attrval pattern : _ string_attrval ping : _ string_attrval placeholder : _ string_attrval playsinline : attrval poster : _ string_attrval preload : [< `none | `metadata | `auto ] to_attrval readonly : attrval referrerpolicy :
+ [< `subtitles | `captions | `descriptions | `chapters | `metadata ] to_attrval label_ : _ string_attrval lang : _ string_attrval list : _ string_attrval loading_lazy : attrSee https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading. loading=eager is the default so no need for specifically that value.
val loop : attrval low : float to_attrval max : _ string_attrval maxlength : int to_attrval media : _ string_attrval min : _ string_attrval minlength : int to_attrval multiple : attrval muted : attrval name : _ string_attrval novalidate : attrval onblur : _ string_attrNote that the value of this attribute is not escaped.
val onclick : _ string_attrNote that the value of this attribute is not escaped.
val open_ : attrval optimum : float to_attrval pattern : _ string_attrval ping : _ string_attrval placeholder : _ string_attrval playsinline : attrval popover : [< `auto | `manual ] to_attrval popovertarget : _ string_attrval popovertargetaction : [< `hide | `show ] to_attrtoggle is the default.
val poster : _ string_attrval preload : [< `none | `metadata | `auto ] to_attrval readonly : attrval referrerpolicy :
[< `no_referrer
| `no_referrer_when_downgrade
| `origin
@@ -150,12 +152,11 @@
| `tree
| `treegrid
| `treeitem ]
- to_attrval rows : int to_attrval rowspan : int to_attrval sandbox : _ string_attrval scope : _ string_attrval selected : attrval shape : _ string_attrval size : _ string_attrval sizes : _ string_attrval slot_ : _ string_attrval span_ : int to_attrval spellcheck : bool to_attrval src : _ string_attrval srcdoc : _ string_attrval srclang : _ string_attrval srcset : _ string_attrval start : int to_attrval step : _ string_attrval style_ : _ string_attrNote that the value of this attribute is not escaped.
val tabindex : int to_attrval target : _ string_attrval title_ : _ string_attrval translate : [< `yes | `no ] to_attrval type_ : _ string_attrNote: this can't be restricted to just the allowed values for <input type>, because it's used in other elements e.g. <link type>.
val usemap : _ string_attrval value : _ string_attrval width : _ string_attrval wrap : [< `hard | `soft ] to_attrTags
HTML tags. Most (standard tags) are constructed by passing a list of attributes and a list of children:
div [id "my-div"] [p [] [txt "Hello"]]
Some (void elements) are constructed only with a list of attributes:
input [required; type_ "email"; name "email-addr"]
Finally, a few (text elements) are constructed with a list of attributes and a single format string child:
title [] "Document title"
-
-title [] "My App ・ %s" page_name
-
-script [] {|alert('Careful, this is not escaped :-)');|}
A tag that will not be rendered in the markup. Useful for containing a bunch of child nodes inside a single node without having to litter the DOM with an actual node. Also may be called 'splicing'.
null [
- p [] [txt "This paragraph."];
- p [] [txt "And this paragraph."];
- p [] [txt "Are spliced directly into the document without a containing node."];
-]
Also useful for constructing a completely empty node that is erased when printing:
null []
val a : std_tagval address : std_tagval area : void_tagval abbr : std_tagval article : std_tagval aside : std_tagval audio : std_tagval b : std_tagval base : void_tagval bdi : std_tagval bdo : std_tagval blockquote : std_tagval body : std_tagval br : void_tagval button : std_tagval canvas : std_tagval caption : std_tagval cite : std_tagval code : std_tagval col : void_tagval colgroup : std_tagval data : std_tagval datalist : std_tagval dd : std_tagval del : std_tagval details : std_tagval dfn : std_tagval dialog : std_tagval div : std_tagval dl : std_tagval dt : std_tagval em : std_tagval embed : void_tagval fieldset : std_tagval figcaption : std_tagval figure : std_tagval form : std_tagval h1 : std_tagval h2 : std_tagval h3 : std_tagval h4 : std_tagval h5 : std_tagval h6 : std_tagval head : std_tagval header : std_tagval hgroup : std_tagval hr : void_tagval html : std_tagA <!DOCTYPE html> declaration is automatically prefixed when this tag is printed.
val i : std_tagval iframe : std_tagval img : void_tagval input : void_tagval ins : std_tagval kbd : std_tagval label : std_tagval legend : std_tagval li : std_tagval link : void_tagval main : std_tagval map : std_tagval mark : std_tagval meta : void_tagval meter : std_tagval noscript : std_tagval object_ : std_tagval ol : std_tagval optgroup : std_tagval option : _ text_tagval output : std_tagval p : std_tagval picture : std_tagval pre : std_tagval progress : std_tagval q : std_tagval rp : std_tagval rt : std_tagval ruby : std_tagval s : std_tagval samp : std_tagval script : _ text_tagNote that the content of this tag is not escaped.
val section : std_tagval select : std_tagval slot : std_tagval small : std_tagval source : void_tagval span : std_tagval strong : std_tagval style : _ text_tagNote that the content of this tag is not escaped.
val sub : std_tagval summary : std_tagval sup : std_tagval table : std_tagval tbody : std_tagval td : std_tagval template : std_tagval textarea : _ text_tagval tfoot : std_tagval th : std_tagval thead : std_tagval time : std_tagval title : _ text_tagval tr : std_tagval track : void_tagval u : std_tagval ul : std_tagval var : std_tagval video : std_tagval wbr : void_tag
+ to_attrval rows : int to_attrval rowspan : int to_attrval sandbox : _ string_attrval scope : _ string_attrval selected : attrval shadowrootclonable : attrval shadowrootdelegatesfocus : attrval shadowrootmode : [ `open_ | `closed ] to_attrval shape : _ string_attrval size : _ string_attrval sizes : _ string_attrval slot_ : _ string_attrval span_ : int to_attrval spellcheck : bool to_attrval src : _ string_attrval srcdoc : _ string_attrval srclang : _ string_attrval srcset : _ string_attrval start : int to_attrval step : _ string_attrval style_ : _ string_attrNote that the value of this attribute is not escaped.
val tabindex : int to_attrval target : _ string_attrval title_ : _ string_attrval translate : [< `yes | `no ] to_attrval type_ : _ string_attrNote: this can't be restricted to just the allowed values for <input type>, because it's used in other elements e.g. <link type>.
val usemap : _ string_attrval value : _ string_attrval width : _ string_attrval wrap : [< `hard | `soft ] to_attrTags
HTML tags. Most (standard tags) are constructed by passing a list of attributes and a list of children:
div [id "my-div"] [p [] [txt "Hello"]]
Some (void elements) are constructed only with a list of attributes:
input [required; type_ "email"; name "email-addr"]
Finally, a few (text elements) are constructed with a list of attributes and a single format string child:
title [] "Document title" title [] "My App ・ %s" page_name script []
+ {|alert('Careful, this is not escaped :-)');|}
A tag that will not be rendered in the markup. Useful for containing a bunch of child nodes inside a single node without having to litter the DOM with an actual node. Also may be called 'splicing'.
null
+ [ p [] [txt "This paragraph."];
+ p [] [txt "And this paragraph."];
+ p []
+ [ txt
+ "Are spliced directly into the document without a containing node."
+ ] ]
Also useful for constructing a completely empty node that is erased when printing: null [].
val a : std_tagval address : std_tagval area : void_tagval abbr : std_tagval article : std_tagval aside : std_tagval audio : std_tagval b : std_tagval base : void_tagval bdi : std_tagval bdo : std_tagval blockquote : std_tagval body : std_tagval br : void_tagval button : std_tagval canvas : std_tagval caption : std_tagval cite : std_tagval code : std_tagval col : void_tagval colgroup : std_tagval data : std_tagval datalist : std_tagval dd : std_tagval del : std_tagval details : std_tagval dfn : std_tagval dialog : std_tagval div : std_tagval dl : std_tagval dt : std_tagval em : std_tagval embed : void_tagval fieldset : std_tagval figcaption : std_tagval figure : std_tagval form : std_tagval h1 : std_tagval h2 : std_tagval h3 : std_tagval h4 : std_tagval h5 : std_tagval h6 : std_tagval head : std_tagval header : std_tagval hgroup : std_tagval hr : void_tagval html : std_tagA <!DOCTYPE html> declaration is automatically prefixed when this tag is printed.
val i : std_tagval iframe : std_tagval img : void_tagval input : void_tagval ins : std_tagval kbd : std_tagval label : std_tagval legend : std_tagval li : std_tagval link : void_tagval main : std_tagval map : std_tagval mark : std_tagval meta : void_tagval meter : std_tagval noscript : std_tagval object_ : std_tagval ol : std_tagval optgroup : std_tagval option : _ text_tagval output : std_tagval p : std_tagval picture : std_tagval pre : std_tagval progress : std_tagval q : std_tagval rp : std_tagval rt : std_tagval ruby : std_tagval s : std_tagval samp : std_tagval script : _ text_tagNote that the content of this tag is not escaped.
val search : std_tagval section : std_tagval select : std_tagval selectedoption : std_tagval slot : std_tagval small : std_tagval source : void_tagval span : std_tagval strong : std_tagval style : _ text_tagNote that the content of this tag is not escaped.
val sub : std_tagval summary : std_tagval sup : std_tagval table : std_tagval tbody : std_tagval td : std_tagval template : std_tagval textarea : _ text_tagval tfoot : std_tagval th : std_tagval thead : std_tagval time : std_tagval title : _ text_tagval tr : std_tagval track : void_tagval u : std_tagval ul : std_tagval var : std_tagval video : std_tagval wbr : void_tag
diff --git a/pure-html/Pure_html/Hx/index.html b/pure-html/Pure_html/Hx/index.html
index 04c81c6..2ece9c5 100644
--- a/pure-html/Pure_html/Hx/index.html
+++ b/pure-html/Pure_html/Hx/index.html
@@ -1,2 +1,2 @@
-Hx (pure-html.Pure_html.Hx) Module Pure_html.Hx
htmx support
The attributes in this module are arranged in the same order as on the reference page linked above.
Remember that you will also need the htmx script itself. The recommended way to get it is to download a copy and place it in your static assets directory, managed by dreamwork so that it is properly cached and version-hashed by its contents.
Core attributes
val get : _ string_attrval post : _ string_attrval on_ : event:string -> _ string_attrThe hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
val push_url : _ string_attrval select : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val target : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attrNote that the value of this attribute is not escaped.
val vals : _ string_attrAdditional attributes
val boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disabled_elt : _ string_attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval headers : _ string_attrval history_false : attrHardcoding of the hx-history attribute to false.
val history_elt : attrval include_ : _ string_attrval indicator : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attrval params : _ string_attrval patch : _ string_attrval preserve : attrval prompt : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ string_attrval sync : _ string_attrval validate : attrExtensions
val preload : attrThe preload extension: https://htmx.org/extensions/preload/
val sse_close : _ string_attrval sse_connect : _ string_attrval sse_swap : _ string_attrval ws_connect : _ string_attrval ws_send : attrOther
val __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val on : _ string_attrNote that the value of this attribute is not escaped.
+Hx (pure-html.Pure_html.Hx) Module Pure_html.Hx
htmx support
The attributes in this module are arranged in the same order as on the reference page linked above.
Remember that you will also need the htmx script itself. The recommended way to get it is to download a copy and place it in your static assets directory, managed by dreamwork so that it is properly cached and version-hashed by its contents.
Core attributes
val get : _ string_attrval post : _ string_attrval on_ : event:string -> _ string_attrThe hx-on:* set of attributes, where * represents DOM events: https://htmx.org/attributes/hx-on/.
Note that the value of this attribute is not escaped.
val push_url : _ string_attrval select : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val select_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val swap_oob : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val target : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val trigger : _ string_attrNote that the value of this attribute is not escaped.
val vals : _ string_attrAdditional attributes
val boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disabled_elt : _ string_attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval headers : _ string_attrval history_false : attrHardcoding of the hx-history attribute to false.
val history_elt : attrval include_ : _ string_attrval indicator : _ string_attrNote that the value of this attribute is not escaped as it may include a CSS selector.
val inherit_ : _ string_attrval params : _ string_attrval patch : _ string_attrval preserve : attrval prompt : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ string_attrval sync : _ string_attrval validate : attrExtensions
val preload : attrThe preload extension: https://htmx.org/extensions/preload/
val sse_close : _ string_attrval sse_connect : _ string_attrval sse_swap : _ string_attrval ws_connect : _ string_attrval ws_send : attrOther
val __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val on : _ string_attrNote that the value of this attribute is not escaped.
diff --git a/pure-html/Pure_html/MathML/index.html b/pure-html/Pure_html/MathML/index.html
index 53664e0..3790e34 100644
--- a/pure-html/Pure_html/MathML/index.html
+++ b/pure-html/Pure_html/MathML/index.html
@@ -1,2 +1,2 @@
-MathML (pure-html.Pure_html.MathML) Module Pure_html.MathML
val accent : bool to_attrval accentunder : bool to_attrval columnspan : int to_attrval depth : _ string_attrval dir : [ `ltr | `rtl ] to_attrval display_block : attrSee https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attrval fence : bool to_attrval height : _ string_attrval largeop : bool to_attrval linethickness : _ string_attrval lspace : _ string_attrval mathvariant : _ string_attrval maxsize : _ string_attrval minsize : _ string_attrval movablelimits : bool to_attrval rowspan : int to_attrval rspace : _ string_attrval scriptlevel : _ string_attrval separator : bool to_attrval stretchy : bool to_attrval symmetric : bool to_attrval voffset : _ string_attrval xmlns : attrval annotation : std_tagval annotation_xml : std_tagval math : std_tagval merror : std_tagval mfrac : std_tagval mi : std_tagval mmultiscripts : std_tagval mn : std_tagval mo : std_tagval mover : std_tagval mpadded : std_tagval mphantom : std_tagval mroot : std_tagval mrow : std_tagval ms : std_tagval mspace : std_tagval msqrt : std_tagval mstyle : std_tagval msub : std_tagval msubsup : std_tagval msup : std_tagval mtable : std_tagval mtd : std_tagval mtext : std_tagval mtr : std_tagval munder : std_tagval munderover : std_tagval semantics : std_tag
+MathML (pure-html.Pure_html.MathML) Module Pure_html.MathML
val accent : bool to_attrval accentunder : bool to_attrval columnspan : int to_attrval depth : _ string_attrval dir : [ `ltr | `rtl ] to_attrval display_block : attrSee https://developer.mozilla.org/en-US/docs/Web/MathML/Element/math#display. display=inline is the default, so there is no need to bind its value.
val displaystyle : bool to_attrval fence : bool to_attrval height : _ string_attrval largeop : bool to_attrval linethickness : _ string_attrval lspace : _ string_attrval mathvariant : _ string_attrval maxsize : _ string_attrval minsize : _ string_attrval movablelimits : bool to_attrval rowspan : int to_attrval rspace : _ string_attrval scriptlevel : _ string_attrval separator : bool to_attrval stretchy : bool to_attrval symmetric : bool to_attrval voffset : _ string_attrval xmlns : attrval annotation : std_tagval annotation_xml : std_tagval math : std_tagval merror : std_tagval mfrac : std_tagval mi : std_tagval mmultiscripts : std_tagval mn : std_tagval mo : std_tagval mover : std_tagval mpadded : std_tagval mphantom : std_tagval mroot : std_tagval mrow : std_tagval ms : std_tagval mspace : std_tagval msqrt : std_tagval mstyle : std_tagval msub : std_tagval msubsup : std_tagval msup : std_tagval mtable : std_tagval mtd : std_tagval mtext : std_tagval mtr : std_tagval munder : std_tagval munderover : std_tagval semantics : std_tag
diff --git a/pure-html/Pure_html/RSS/index.html b/pure-html/Pure_html/RSS/index.html
index af41ddc..dde8eb6 100644
--- a/pure-html/Pure_html/RSS/index.html
+++ b/pure-html/Pure_html/RSS/index.html
@@ -1,2 +1,2 @@
-RSS (pure-html.Pure_html.RSS) Module Pure_html.RSS
RSS support
Attributes
val domain : _ string_attrval version_2 : attrval xmlns_atom : attrTags
val author : _ text_tagval channel : std_tagval category : _ text_tagval comments : _ text_tagval copyright : _ text_tagval description : _ text_tagval docs : _ text_tagval generator : _ text_tagval guid : _ text_tagval item : std_tagval language : _ text_tagval last_build_date : _ text_tagval link : _ text_tagval managing_editor : _ text_tagval pub_date : _ text_tagval rss : std_tagval title : _ text_tagval ttl : _ text_tagval web_master : _ text_tag
+RSS (pure-html.Pure_html.RSS) Module Pure_html.RSS
RSS support
Attributes
val domain : _ string_attrval length : int to_attrval path : _ string_attrval port : int to_attrval protocol : _ string_attrval register_procedure : _ string_attrval type_ : _ string_attrval url_ : _ string_attrval version_2 : attrTags
val author : _ text_tagval channel : std_tagval category : _ text_tagval cloud : void_tagval comments : _ text_tagval copyright : _ text_tagval description : _ text_tagval docs : _ text_tagval enclosure : std_tagval generator : _ text_tagval guid : _ text_tagval height : _ text_tagval image : std_tagval item : std_tagval language : _ text_tagval last_build_date : _ text_tagval link : _ text_tagval managing_editor : _ text_tagval pub_date : _ text_tagval rss : std_tagval title : _ text_tagval ttl : _ text_tagval url : _ text_tagval web_master : _ text_tagval width : _ text_tag
diff --git a/pure-html/Pure_html/SVG/index.html b/pure-html/Pure_html/SVG/index.html
index ecc69b2..370df0e 100644
--- a/pure-html/Pure_html/SVG/index.html
+++ b/pure-html/Pure_html/SVG/index.html
@@ -1,3 +1,3 @@
-SVG (pure-html.Pure_html.SVG) Module Pure_html.SVG
val d : _ string_attrval fill : _ string_attrval stroke : _ string_attrval stroke_linecap : [< `butt | `round | `square ] to_attrval stroke_linejoin :
+SVG (pure-html.Pure_html.SVG) Module Pure_html.SVG
val d : _ string_attrval fill : _ string_attrval stroke : _ string_attrval stroke_linecap : [< `butt | `round | `square ] to_attrval stroke_linejoin :
[< `arcs | `bevel | `miter | `miter_clip | `round ] to_attrval stroke_width : _ string_attrval viewbox : min_x:int -> min_y:int -> width:int -> height:int -> attrval xmlns : attrval path : std_tagval svg : std_tag
diff --git a/pure-html/Pure_html/index.html b/pure-html/Pure_html/index.html
index 1abe8fd..37ed21b 100644
--- a/pure-html/Pure_html/index.html
+++ b/pure-html/Pure_html/index.html
@@ -1,11 +1,11 @@
-Pure_html (pure-html.Pure_html) Module Pure_html
Use this module for constructing HTML without any dependency on the Dream web framework.
Core types
These are the types of the final values which get rendered.
Output
val to_string : node -> stringval to_xml : ?header:bool -> node -> stringSame as to_string but render void tags as XML-style self-closing tags.
val pp : Stdlib.Format.formatter -> node -> unitval pp_xml : Stdlib.Format.formatter -> ?header:bool -> node -> unitSame as pp but render void tags as XML-style self-closing tags.
Constructing nodes and attributes
type 'a to_attr = 'a -> attrAttributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'aSpecial handling for string-value attributes so they can use format strings i.e. string interpolation.
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attrattr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
val string_attr : string -> ?raw:bool -> _ string_attrstring_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attrConvenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
+Pure_html (pure-html.Pure_html) Module Pure_html
Use this module for constructing HTML without any dependency on the Dream web framework.
Core types
These are the types of the final values which get rendered.
Output
val to_string : node -> stringval to_xml : ?header:bool -> node -> stringSame as to_string but render void tags as XML-style self-closing tags.
val pp : Stdlib.Format.formatter -> node -> unitval pp_xml : Stdlib.Format.formatter -> ?header:bool -> node -> unitSame as pp but render void tags as XML-style self-closing tags.
Constructing nodes and attributes
type 'a to_attr = 'a -> attrAttributes can be created from typed values.
type 'a string_attr = ('a, unit, string, attr) Stdlib.format4 -> 'aSpecial handling for string-value attributes so they can use format strings i.e. string interpolation.
A 'void element': https://developer.mozilla.org/en-US/docs/Glossary/Void_element with no children.
Tags which can have attributes but can contain only text. The text can be formatted.
val attr : string -> attrattr name is a new attribute which does not carry any payload. E.g.
let required = attr "required"
val string_attr : string -> ?raw:bool -> _ string_attrstring_attr name fmt is a new string-valued attribute which allows formatting i.e. string interpolation of the value. Note, the fmt argument is required due to the value restriction.
val uri_attr : string -> _ string_attrConvenience for attributes whose values should be URIs. Takes care of both URI-encoding and attribute escaping, as recommended in https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html#common-mistake.
Examples
a [href "/blog?tags=iamsafe\"></a><script>alert('Pwned')</script>"] [txt "Tags: tag1 | tag2"]
==>
<a href="/blog?tags=iamsafe%22%3E%3C/a%3E%3Cscript%3Ealert('Pwned')%3C/script%3E">Tags: tag1 | tag2</a>
a [href "/foo?a=1&b=2 3&c=4<5&d=6>5"] [txt "Test"]
==>
-<a href="/foo?a=1&b=2%203&c=4%3C5&d=6%3E5">Test</a>
val bool_attr : string -> bool to_attrval float_attr : string -> float to_attrval int_attr : string -> int to_attrval std_tag : string -> std_tagval void_tag : string -> void_tagval text_tag : string -> ?raw:bool -> _ text_tagBuild a tag which can contain only text.
val uri_tag : string -> _ text_tagBuild a tag which can contain only a URI. The URI is scaped with the same rules as a uri_attr.
val txt : ?raw:bool -> ('a, unit, string, node) Stdlib.format4 -> 'aA text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:
b [] [txt "Hello, %s!" name]
Or without interpolation:
b [] [txt "Bold of you."]
HTML-escapes the text value. You can use the ~raw param to bypass escaping:
let user_input = "<script>alert('I like HTML injection')</script>" in
+<a href="/foo?a=1&b=2%203&c=4%3C5&d=6%3E5">Test</a>
val bool_attr : string -> bool to_attrval float_attr : string -> float to_attrval int_attr : string -> int to_attrval std_tag : string -> std_tagval void_tag : string -> void_tagval text_tag : string -> ?raw:bool -> _ text_tagBuild a tag which can contain only text.
val uri_tag : string -> _ text_tagBuild a tag which can contain only a URI. The URI is escaped with the same rules as a uri_attr.
val txt : ?raw:bool -> ('a, unit, string, node) Stdlib.format4 -> 'aA text node inside the DOM e.g. the 'hi' in <b>hi</b>. Allows string interpolation using the same formatting features as Printf.sprintf:
b [] [txt "Hello, %s!" name]
Or without interpolation:
b [] [txt "Bold of you."]
HTML-escapes the text value. You can use the ~raw param to bypass escaping:
let user_input = "<script>alert('I like HTML injection')</script>" in
txt ~raw:true "%s" user_input
val comment : string -> nodeA comment that will be embedded in the rendered HTML, i.e. <!-- comment -->. The text is HTML-escaped.
Accessors for tags
Add an attribute to a tag.
let toast msg = p [id "toast"] [txt "%s" msg]
let toast_oob = toast "ok." +@ Hx.swap_oob "true"
val (.@[]) : node -> string -> stringGet the value of an existing attribute.
let toast = p [id "toast"] [txt "OK."]
let toast_id = toast.@["id"]
val is_null : node -> boolGet whether a node is null (empty) or not. Useful for conditional rendering of UIs when you are passed in a node and you don't know if it's empty or not.
val is_null_ : attr -> boolGet whether an attribute is null (empty) or not.
HTML
module HTML : sig ... endAll standard HTML attributes and tags. Some attributes and tags have the same name, e.g. style. To disambiguate them, attributes have a _ (underscore) suffix.
SVG
module SVG : sig ... endMathML
module MathML : sig ... endARIA
module Aria : sig ... endRSS and Atom
module Atom : sig ... endhtmx
diff --git a/pure-html/index.html b/pure-html/index.html
index 940eb24..d557822 100644
--- a/pure-html/index.html
+++ b/pure-html/index.html
@@ -1,2 +1,2 @@
-index (pure-html.index) pure-html index
Library pure-html
The entry point of this library is the module: Pure_html.
+index (pure-html.index) pure-html index
Library pure-html
The entry point of this library is the module: Pure_html.
diff --git a/sql.txt b/sql.txt
deleted file mode 100644
index 53431a0..0000000
--- a/sql.txt
+++ /dev/null
@@ -1,22 +0,0 @@
-open Caqti_type.Std
-
-(* type prepared = Caqti_type.t * (Caqti_driver_info.t -> Caqti_query.t) *)
-
-let rec arg_type' :
- type r t.
- ?tuple_size:int ->
- (r, _, _, _, _, t Caqti_type.t) CamlinternalFormatBasics.fmt ->
- r ->
- t Caqti_type.t =
- fun ?(tuple_size = 0) fmt ->
- match fmt with
- | String (No_padding, fmt) -> assert false
- | _ -> assert false
-
-let arg_type (CamlinternalFormatBasics.Format (fmt, _)) = arg_type' fmt proj_end
-let row_type _ = assert false
-let query _ = assert false
-
-let all afmt rfmt =
- Caqti_request.create (arg_type afmt) (row_type rfmt) Caqti_mult.zero_or_more
- (query afmt)
diff --git a/todos/1 b/todos/1
deleted file mode 100644
index 79a88bd..0000000
--- a/todos/1
+++ /dev/null
@@ -1 +0,0 @@
-1 false abba
\ No newline at end of file
diff --git a/todos/2 b/todos/2
deleted file mode 100644
index 723c148..0000000
--- a/todos/2
+++ /dev/null
@@ -1 +0,0 @@
-2 false aa
\ No newline at end of file
diff --git a/todos/3 b/todos/3
deleted file mode 100644
index 13e8d50..0000000
--- a/todos/3
+++ /dev/null
@@ -1 +0,0 @@
-3 false aaa
\ No newline at end of file
diff --git a/todos/4 b/todos/4
deleted file mode 100644
index b6785fa..0000000
--- a/todos/4
+++ /dev/null
@@ -1 +0,0 @@
-4 false milk
\ No newline at end of file
diff --git a/todos/5 b/todos/5
deleted file mode 100644
index 1865a4b..0000000
--- a/todos/5
+++ /dev/null
@@ -1 +0,0 @@
-5 false eggs
\ No newline at end of file
diff --git a/todos/6 b/todos/6
deleted file mode 100644
index 72c954e..0000000
--- a/todos/6
+++ /dev/null
@@ -1 +0,0 @@
-6 true bananas
\ No newline at end of file
diff --git a/todos/7 b/todos/7
deleted file mode 100644
index 23c0de9..0000000
--- a/todos/7
+++ /dev/null
@@ -1 +0,0 @@
-7 true laundry
\ No newline at end of file