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 | `polite ] to_attrval 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 | `polite ] to_attrval 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.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 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 async : attrval autocapitalize :
[< `off | `none | `on | `sentences | `words | `characters ] to_attrval autocomplete :
[< `off
| `on
@@ -149,13 +150,12 @@
| `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 on 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 text child:
title [] "Document title"
+ to_attr
val 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_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."]
- ]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_tagA 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_tagDream_html.Hxhtmx support https://htmx.org/reference/
val __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval get : _ 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 on : _ string_attrNote that the value of this attribute is not escaped.
val 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 params : _ string_attrval patch : _ string_attrval post : _ string_attrval preload : attrThe preload extension: https://htmx.org/extensions/preload/
val preserve : attrval prompt : _ string_attrval push_url : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ 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 sse_connect : _ string_attrval sse_swap : _ string_attrval 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 sync : _ string_attrval 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 validate : attrval vals : _ string_attrval ws_connect : _ string_attrval ws_send : attrDream_html.Hxhtmx support https://htmx.org/reference/
val __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval get : _ 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 on : _ string_attrNote that the value of this attribute is not escaped.
val 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 params : _ string_attrval patch : _ string_attrval post : _ string_attrval preload : attrThe preload extension: https://htmx.org/extensions/preload/
val preserve : attrval prompt : _ string_attrval push_url : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ 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 sse_connect : _ string_attrval sse_swap : _ string_attrval 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 sync : _ string_attrval 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 validate : attrval vals : _ string_attrval ws_connect : _ string_attrval ws_send : attrDream_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 () = Dream.run
+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;
@@ -7,4 +7,4 @@
]
val script : node(2) Put this inside your head:
head [] [
Livereload.script;
(* ... *)
-]
(3) And run the server with environment variable ENV=dev.
⚠️ 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.
+](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.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 caa10cc..12b3162 100644
--- a/dream-html/Dream_html/index.html
+++ b/dream-html/Dream_html/index.html
@@ -1,17 +1,14 @@
-Dream_html (dream-html.Dream_html) Module Dream_html
Constructing HTML. Detailed explanation in https://github.com/yawaramin/dream-html.
Let's adapt the example from the Dream home page:
let hello who =
- let open Dream_html in
- let open HTML in
- html [] [
- body [] [
- h1 [] [txt "Hello, %s!" who];
- ];
- ]
+Dream_html (dream-html.Dream_html) Module Dream_html
include module type of Pure_html
Core types
These are the types of the final values which get rendered.
Output
val to_string : node -> stringval to_xml : 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 -> 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>
-let () =
- Dream.run
- @@ Dream.logger
- @@ Dream.router [Dream.get "/" (fun _ -> Dream_html.respond (hello "world"))]
More examples shown below.
Note that the version of this library installed on your device may have outdated documentation strings. To view the latest documentation, please visit the repository page.
Core types
These are the types of the final values which get rendered.
Output
val to_string : node -> stringval to_xml : 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 -> node -> unitSame as pp but render void tags as XML-style self-closing tags.
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 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.
Standard attributes and tags
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.
module SVG : sig ... endmodule MathML : sig ... endARIA support
module Aria : sig ... endhtmx support
module Hx : sig ... endhtmx support https://htmx.org/reference/
Output
val respond :
?status:[< Dream.status ] ->
?code:int ->
?headers:(string * string) list ->
@@ -21,15 +18,6 @@
?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.
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 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.
val csrf_tag : Dream.request -> nodeConvenience to add a CSRF token generated by Dream into your form. Type-safe wrapper for Dream.csrf_tag.
form
+ unit Dream.promise
Type-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 wrapper for Dream.csrf_tag.
form
[action "/foo"]
- [csrf_tag req; input [name "bar"]; input [type_ "submit"]]
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.
Standard attributes and tags
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.
module SVG : sig ... endmodule MathML : sig ... endARIA support
module Aria : sig ... endhtmx support
module Hx : sig ... endhtmx support https://htmx.org/reference/
Live reload support
module Livereload : sig ... endLive 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.
+ [csrf_tag req; input [name "bar"]; input [type_ "submit"]]Live reload support
module Livereload : sig ... endLive 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.
diff --git a/dream-html/index.html b/dream-html/index.html
index f717afa..b4ff5c1 100644
--- a/dream-html/index.html
+++ b/dream-html/index.html
@@ -1,2 +1,2 @@
-index (dream-html.index) dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.
+index (dream-html.index) dream-html index
Library dream-html
The entry point of this library is the module: Dream_html.
diff --git a/index.html b/index.html
index 1614e60..c7f1858 100644
--- a/index.html
+++ b/index.html
@@ -1,19 +1,304 @@
-
+
+
+
+ dream-html - Render HTML, SVG, MathML, htmx markup from your OCaml Dream backend server
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Renders OCaml:
+ open Dream_html
+open HTML
+ html [lang "en"] [
+ head [] [
+ title [] "My page";
+ ];
+ body [] [
+ h1 [] [txt "My text"];
+ ];
+]
+
+
+ To HTML/SVG/MathML (try it):
+
+
+
+
+
+
+ Install & use
+
+ See the readme.
+
+
+
+
+
\ No newline at end of file
diff --git a/odoc.support/odoc.css b/odoc.support/odoc.css
index c23517b..71148de 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.1 */
+ odoc 2.4.2 */
/* Fonts */
/* noticia-text-regular - latin */
diff --git a/pure-html/Pure_html/Aria/index.html b/pure-html/Pure_html/Aria/index.html
new file mode 100644
index 0000000..54ebf1c
--- /dev/null
+++ b/pure-html/Pure_html/Aria/index.html
@@ -0,0 +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 | `polite ] to_attrval 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/HTML/index.html b/pure-html/Pure_html/HTML/index.html
new file mode 100644
index 0000000..998fede
--- /dev/null
+++ b/pure-html/Pure_html/HTML/index.html
@@ -0,0 +1,161 @@
+
+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 async : attrval autocapitalize :
+ [< `off | `none | `on | `sentences | `words | `characters ] to_attrval autocomplete :
+ [< `off
+ | `on
+ | `name
+ | `honorific_prefix
+ | `given_name
+ | `additional_name
+ | `honorific_suffix
+ | `nickname
+ | `email
+ | `username
+ | `new_password
+ | `current_password
+ | `one_time_code
+ | `organization_title
+ | `organization
+ | `street_address
+ | `address_line1
+ | `address_line2
+ | `address_line3
+ | `address_level4
+ | `address_level3
+ | `address_level2
+ | `address_level1
+ | `country
+ | `country_name
+ | `postal_code
+ | `cc_name
+ | `cc_given_name
+ | `cc_additional_name
+ | `cc_family_name
+ | `cc_number
+ | `cc_exp
+ | `cc_exp_month
+ | `cc_exp_year
+ | `cc_csc
+ | `cc_type
+ | `transaction_currency
+ | `transaction_amount
+ | `language
+ | `bday
+ | `bday_day
+ | `bday_month
+ | `bday_year
+ | `sex
+ | `tel
+ | `tel_country_code
+ | `tel_national
+ | `tel_area_code
+ | `tel_local
+ | `tel_extension
+ | `impp
+ | `url
+ | `photo
+ | `webauthn ]
+ to_attrval autofocus : attrval autoplay : attrval buffered : _ string_attrval capture : [< `user | `environment ] to_attrval charset : _ string_attrval checked : attrval cite_ : _ string_attrval class_ : _ string_attrval color : _ string_attrval cols : int to_attrval colspan : int to_attrval content : _ string_attrval contenteditable : bool to_attrval controls : attrval coords : _ string_attrval crossorigin : [< `anonymous | `use_credentials ] to_attrval data_ : _ string_attrval datetime : _ string_attrval decoding : [< `sync | `async | `auto ] to_attrval default : attrval defer : attrval dir : [< `ltr | `rtl | `auto ] to_attrval dirname : _ string_attrval disabled : attrval download : _ string_attrval draggable : attrval fetchpriority : [< `high | `low | `auto ] to_attrval for_ : _ string_attrval form_ : _ string_attrval formaction : _ string_attrval formnovalidate : attrval formtarget : _ string_attrval headers : _ string_attrval height : _ string_attrval high : float to_attrval href : _ string_attrval hreflang : _ string_attrval http_equiv :
+ [< `content_security_policy
+ | `content_type
+ | `default_style
+ | `x_ua_compatible
+ | `refresh ]
+ to_attrval id : _ string_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 :
+ [< `no_referrer
+ | `no_referrer_when_downgrade
+ | `origin
+ | `origin_when_cross_origin
+ | `same_origin
+ | `strict_origin
+ | `strict_origin_when_cross_origin
+ | `unsafe_url ]
+ to_attrval rel : _ string_attrval required : attrval reversed : attrval role :
+ [ `alert
+ | `alertdialog
+ | `application
+ | `article
+ | `banner
+ | `button
+ | `cell
+ | `checkbox
+ | `columnheader
+ | `combobox
+ | `comment
+ | `complementary
+ | `contentinfo
+ | `definition
+ | `dialog
+ | `document
+ | `feed
+ | `figure
+ | `form
+ | `generic
+ | `grid
+ | `gridcell
+ | `group
+ | `heading
+ | `img
+ | `link
+ | `list
+ | `listbox
+ | `listitem
+ | `log
+ | `main
+ | `mark
+ | `marquee
+ | `math
+ | `menu
+ | `menubar
+ | `menuitem
+ | `menuitemcheckbox
+ | `menuitemradio
+ | `meter
+ | `navigation
+ | `none
+ | `note
+ | `option
+ | `presentation
+ | `progressbar
+ | `radio
+ | `radiogroup
+ | `region
+ | `row
+ | `rowgroup
+ | `rowheader
+ | `scrollbar
+ | `search
+ | `searchbox
+ | `separator
+ | `slider
+ | `spinbutton
+ | `status
+ | `suggestion
+ | `switch
+ | `tab
+ | `table
+ | `tablist
+ | `tabpanel
+ | `term
+ | `textbox
+ | `timer
+ | `toolbar
+ | `tooltip
+ | `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
diff --git a/pure-html/Pure_html/Hx/index.html b/pure-html/Pure_html/Hx/index.html
new file mode 100644
index 0000000..c4638a0
--- /dev/null
+++ b/pure-html/Pure_html/Hx/index.html
@@ -0,0 +1,2 @@
+
+Hx (pure-html.Pure_html.Hx) Module Pure_html.Hx
htmx support https://htmx.org/reference/
val __ : _ string_attrThis attribute serves as the _ attribute, which is used by Hyperscript. Note that the value of this attribute is not escaped.
val boost : bool to_attrval confirm : _ string_attrval delete : _ string_attrval disable : attrval disinherit : _ string_attrval encoding_formdata : attrHardcoding of the hx-encoding attribute to multipart/form-data.
val ext : _ string_attrval get : _ 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 on : _ string_attrNote that the value of this attribute is not escaped.
val 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 params : _ string_attrval patch : _ string_attrval post : _ string_attrval preload : attrThe preload extension: https://htmx.org/extensions/preload/
val preserve : attrval prompt : _ string_attrval push_url : _ string_attrval put : _ string_attrval replace_url : _ string_attrval request : _ 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 sse_connect : _ string_attrval sse_swap : _ string_attrval 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 sync : _ string_attrval 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 validate : attrval vals : _ string_attrval ws_connect : _ string_attrval ws_send : attr
diff --git a/pure-html/Pure_html/MathML/index.html b/pure-html/Pure_html/MathML/index.html
new file mode 100644
index 0000000..7dafdb2
--- /dev/null
+++ b/pure-html/Pure_html/MathML/index.html
@@ -0,0 +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
diff --git a/pure-html/Pure_html/SVG/index.html b/pure-html/Pure_html/SVG/index.html
new file mode 100644
index 0000000..b632bf1
--- /dev/null
+++ b/pure-html/Pure_html/SVG/index.html
@@ -0,0 +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 :
+ [< `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
new file mode 100644
index 0000000..b3be775
--- /dev/null
+++ b/pure-html/Pure_html/index.html
@@ -0,0 +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 : 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 -> 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 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.
Standard attributes and tags
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.
module SVG : sig ... endmodule MathML : sig ... endARIA support
module Aria : sig ... endhtmx support
module Hx : sig ... endhtmx support https://htmx.org/reference/
diff --git a/pure-html/index.html b/pure-html/index.html
new file mode 100644
index 0000000..a4dbecd
--- /dev/null
+++ b/pure-html/index.html
@@ -0,0 +1,2 @@
+
+index (pure-html.index) pure-html index
Library pure-html
The entry point of this library is the module: Pure_html.