@rescript/webapi 0.1.0-alpha-b1d58f9

package/src/html/HTMLElement.res

@@ -0,0 +1,108 @@
+/**
+Represents the observable states of `HTMLElement.hidden`.
+
+- `Visible` means the element is not hidden.
+- `Hidden` means the element is hidden.
+- `HiddenUntilFound` means the element can be revealed by find-in-page or fragment navigation.
+
+[Read more in the HTML Standard](https://html.spec.whatwg.org/multipage/interaction.html#dom-hidden)
+*/
+type hiddenState =
+  | @as(false) Visible
+  | @as(true) Hidden
+  | @as("until-found") HiddenUntilFound
+
+type t = DOMTree.htmlElement = private {
+  ...DOMTree.htmlElement,
+}
+
+module Impl = (
+  T: {
+    type t
+  },
+) => {
+  include Element.Impl({type t = T.t})
+
+  external asHTMLElement: T.t => DOMTree.htmlElement = "%identity"
+
+  /**
+Returns the element's current hidden state.
+
+```rescript
+let description = switch element->HTMLElement.hidden {
+| HTMLElement.Visible => "visible"
+| HTMLElement.Hidden => "hidden"
+| HTMLElement.HiddenUntilFound => "hidden until found"
+}
+```
+
+This getter never returns `null`.
+
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
+*/
+  @get
+  external hidden: T.t => hiddenState = "hidden"
+
+  /**
+Sets the element's semantic hidden state.
+
+```rescript
+element->HTMLElement.setHidden(HTMLElement.Hidden)
+element->HTMLElement.setHidden(HTMLElement.HiddenUntilFound)
+element->HTMLElement.setHidden(HTMLElement.Visible)
+```
+
+The browser also accepts values such as numbers, arbitrary strings, `null`, and
+`undefined`, but coerces each of them to one of these three states. This binding
+intentionally accepts only `hiddenState` so callers express the resulting state
+rather than relying on coercion.
+
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)
+*/
+  @set
+  external setHidden: (T.t, hiddenState) => unit = "hidden"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)
+*/
+  @throws(JsExn) @send
+  external attachInternals: T.t => DOMTree.elementInternals = "attachInternals"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)
+*/
+  @send
+  external blur: T.t => unit = "blur"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)
+*/
+  @send
+  external click: T.t => unit = "click"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)
+*/
+  @send
+  external focus: (T.t, ~options: DOM.focusOptions=?) => unit = "focus"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)
+*/
+  @throws(JsExn) @send
+  external hidePopover: T.t => unit = "hidePopover"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)
+*/
+  @throws(JsExn) @send
+  external showPopover: T.t => unit = "showPopover"
+
+  /**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)
+*/
+  @throws(JsExn) @send
+  external togglePopover: (T.t, ~force: bool=?) => bool = "togglePopover"
+}
+
+include Impl({type t = t})

package/src/html/HTMLEmbedElement.res

@@ -0,0 +1,275 @@
+/**
+Provides special properties (beyond the regular HTMLElement interface it also has available to it by inheritance) for manipulating <embed> elements.
+[See HTMLEmbedElement on MDN](https://developer.mozilla.org/docs/Web/API/HTMLEmbedElement)
+TODO: mark as private once mutating fields of private records is allowed
+*/
+type t = {
+  // Base properties from HTMLElement
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)
+    */
+  mutable title: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)
+    */
+  mutable lang: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)
+    */
+  mutable translate: bool,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)
+    */
+  mutable dir: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)
+    */
+  mutable inert: bool,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)
+    */
+  mutable accessKey: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)
+    */
+  accessKeyLabel: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)
+    */
+  mutable draggable: bool,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)
+    */
+  mutable spellcheck: bool,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)
+    */
+  mutable autocapitalize: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)
+    */
+  mutable innerText: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)
+    */
+  mutable outerText: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)
+    */
+  mutable popover: Null.t<string>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)
+    */
+  offsetParent: Null.t<DOMTree.element>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)
+    */
+  offsetTop: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)
+    */
+  offsetLeft: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)
+    */
+  offsetWidth: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)
+    */
+  offsetHeight: int,
+  // End base properties from HTMLElement
+
+  // Base properties from Element
+  /**
+    Returns the namespace.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)
+    */
+  namespaceURI: Null.t<string>,
+  /**
+    Returns the namespace prefix.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/prefix)
+    */
+  prefix: Null.t<string>,
+  /**
+    Returns the local name.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/localName)
+    */
+  localName: string,
+  /**
+    Returns the HTML-uppercased qualified name.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/tagName)
+    */
+  tagName: string,
+  /**
+    Returns the value of element's id content attribute. Can be set to change it.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/id)
+    */
+  mutable id: string,
+  /**
+    Returns the value of element's class content attribute. Can be set to change it.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/className)
+    */
+  mutable className: string,
+  /**
+    Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/classList)
+    */
+  classList: DOM.domTokenList,
+  /**
+    Returns the value of element's slot content attribute. Can be set to change it.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/slot)
+    */
+  mutable slot: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/attributes)
+    */
+  attributes: DOM.namedNodeMap,
+  /**
+    Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)
+    */
+  shadowRoot: Null.t<DOMTree.shadowRoot>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/part)
+    */
+  part: DOM.domTokenList,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)
+    */
+  mutable scrollTop: float,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)
+    */
+  mutable scrollLeft: float,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)
+    */
+  scrollWidth: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)
+    */
+  scrollHeight: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/clientTop)
+    */
+  clientTop: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)
+    */
+  clientLeft: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)
+    */
+  clientWidth: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)
+    */
+  clientHeight: int,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)
+    */
+  currentCSSZoom: float,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)
+    */
+  @throws(JsExn)
+  mutable innerHTML: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)
+    */
+  @throws(JsExn)
+  mutable outerHTML: string,
+  // End base properties from Element
+
+  // Base properties from Node
+  /**
+    Returns the type of node.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/nodeType)
+    */
+  nodeType: int,
+  /**
+    Returns a string appropriate for the type of node.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/nodeName)
+    */
+  nodeName: string,
+  /**
+    Returns node's node document's document base URL.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/baseURI)
+    */
+  baseURI: string,
+  /**
+    Returns true if node is connected and false otherwise.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/isConnected)
+    */
+  isConnected: bool,
+  /**
+    Returns the node document. Returns null for documents.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)
+    */
+  ownerDocument: Null.t<DOM.document>,
+  /**
+    Returns the parent.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/parentNode)
+    */
+  parentNode: Null.t<DOMTree.node>,
+  /**
+    Returns the parent element.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/parentElement)
+    */
+  parentElement: Null.t<DOMTree.htmlElement>,
+  /**
+    Returns the children.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/childNodes)
+    */
+  childNodes: DOM.nodeList<DOMTree.node>,
+  /**
+    Returns the first child.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/firstChild)
+    */
+  firstChild: Null.t<DOMTree.node>,
+  /**
+    Returns the last child.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/lastChild)
+    */
+  lastChild: Null.t<DOMTree.node>,
+  /**
+    Returns the previous sibling.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)
+    */
+  previousSibling: Null.t<DOMTree.node>,
+  /**
+    Returns the next sibling.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)
+    */
+  nextSibling: Null.t<DOMTree.node>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)
+    */
+  mutable nodeValue: Null.t<string>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Node/textContent)
+    */
+  mutable textContent: Null.t<string>,
+  // End base properties from Node
+
+  /**
+    Sets or retrieves a WebApiURL to be loaded by the object.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLEmbedElement/src)
+    */
+  mutable src: string,
+  /**
+    Sets or retrieves the width of the object.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLEmbedElement/width)
+    */
+  mutable width: string,
+  /**
+    Sets or retrieves the height of the object.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLEmbedElement/height)
+    */
+  mutable height: string,
+}
+
+include HTMLElement.Impl({type t = t})
+
+@send
+external getSVGDocument: t => Null.t<DOM.document> = "getSVGDocument"

package/src/html/HTMLFieldSetElement.res

@@ -0,0 +1,70 @@
+/**
+Provides special properties and methods (beyond the regular HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of <fieldset> elements.
+[See HTMLFieldSetElement on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement)
+TODO: mark as private once mutating fields of private records is allowed
+*/
+type t = {
+  ...DOMTree.htmlElement,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/disabled)
+    */
+  mutable disabled: bool,
+  /**
+    Retrieves a reference to the form that the object is embedded in.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/form)
+    */
+  form: Null.t<DOMTree.htmlFormElement>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/name)
+    */
+  mutable name: string,
+  /**
+    Returns the string "fieldset".
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/type)
+    */
+  @as("type")
+  type_: string,
+  /**
+    Returns an HTMLCollection of the form controls in the element.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/elements)
+    */
+  elements: HTMLCollection.t<DOMTree.element>,
+  /**
+    Returns whether an element will successfully validate based on forms validation rules and constraints.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/willValidate)
+    */
+  willValidate: bool,
+  /**
+    Returns a  ValidityState object that represents the validity states of an element.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/validity)
+    */
+  validity: DOM.validityState,
+  /**
+    Returns the error message that would be displayed if the user submits the form, or an empty string if no error message. It also triggers the standard error message, such as "this is a required field". The result is that the user sees validation messages without actually submitting.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/validationMessage)
+    */
+  validationMessage: string,
+}
+
+include HTMLElement.Impl({type t = t})
+
+/**
+Returns whether a form will validate when it is submitted, without having to submit it.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/checkValidity)
+*/
+@send
+external checkValidity: t => bool = "checkValidity"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/reportValidity)
+*/
+@send
+external reportValidity: t => bool = "reportValidity"
+
+/**
+Sets a custom error message that is displayed when a form is submitted.
+@param error Sets a custom error message that is displayed when a form is submitted.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/setCustomValidity)
+*/
+@send
+external setCustomValidity: (t, string) => unit = "setCustomValidity"

package/src/html/HTMLFormControlsCollection.res

@@ -0,0 +1,21 @@
+type t = DOMTree.htmlFormControlsCollection = private {
+  ...DOMTree.htmlFormControlsCollection,
+}
+
+external asHTMLCollection: DOMTree.htmlFormControlsCollection => HTMLCollection.t<DOMTree.element> =
+  "%identity"
+
+/**
+Retrieves an object from various collections.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLCollection/item)
+*/
+@send
+external item: (DOMTree.htmlFormControlsCollection, int) => Null.t<DOMTree.element> = "item"
+
+/**
+Retrieves a select object or an object from an options collection.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLCollection/namedItem)
+*/
+@send
+external namedItem: (DOMTree.htmlFormControlsCollection, string) => Null.t<DOMTree.element> =
+  "namedItem"

package/src/html/HTMLFormElement.res

@@ -0,0 +1,39 @@
+type t = DOMTree.htmlFormElement = private {
+  ...DOMTree.htmlFormElement,
+}
+
+include HTMLElement.Impl({type t = t})
+
+/**
+Fires when a FORM is about to be submitted.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit)
+*/
+@throws(JsExn) @send
+external submit: DOMTree.htmlFormElement => unit = "submit"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit)
+*/
+@throws(JsExn) @send
+external requestSubmit: (DOMTree.htmlFormElement, ~submitter: DOMTree.htmlElement=?) => unit =
+  "requestSubmit"
+
+/**
+Fires when the user resets a form.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset)
+*/
+@send
+external reset: DOMTree.htmlFormElement => unit = "reset"
+
+/**
+Returns whether a form will validate when it is submitted, without having to submit it.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/checkValidity)
+*/
+@send
+external checkValidity: DOMTree.htmlFormElement => bool = "checkValidity"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reportValidity)
+*/
+@send
+external reportValidity: DOMTree.htmlFormElement => bool = "reportValidity"

package/src/html/HTMLFrameSetElement.res

@@ -0,0 +1,9 @@
+/**
+Provides special properties (beyond those of the regular HTMLElement interface they also inherit) for manipulating <frameset> elements.
+[See HTMLFrameSetElement on MDN](https://developer.mozilla.org/docs/Web/API/HTMLFrameSetElement)
+*/
+type t = private {
+  ...DOMTree.htmlElement,
+}
+
+include HTMLElement.Impl({type t = t})

package/src/html/HTMLHRElement.res

@@ -0,0 +1,9 @@
+/**
+Provides special properties (beyond those of the HTMLElement interface it also has available to it by inheritance) for manipulating <hr> elements.
+[See HTMLHRElement on MDN](https://developer.mozilla.org/docs/Web/API/HTMLHRElement)
+*/
+type t = private {
+  ...DOMTree.htmlElement,
+}
+
+include HTMLElement.Impl({type t = t})