Skip to content
Experimental WebAPI

ShadowRoot

Values

addEventListener

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListener: (
  DomTypes.shadowRoot,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.addEventListenerOptions=?,
) => unit

Parameters

DomTypes.shadowRoot EventTypes.eventType EventTypes.eventListener option< EventTypes.addEventListenerOptions >

Return type

unit

addEventListenerWithCapture

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture. Read more on MDN

let addEventListenerWithCapture: (
  DomTypes.shadowRoot,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.shadowRoot EventTypes.eventType EventTypes.eventListener

Return type

unit

append

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let append: (DomTypes.shadowRoot, DomTypes.node) => unit

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

unit

append2

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let append2: (DomTypes.shadowRoot, string) => unit

Parameters

DomTypes.shadowRoot string

Return type

unit

appendChild

Read more on MDN

let appendChild: (DomTypes.shadowRoot, 't) => 't

asDocumentFragment

let asDocumentFragment: DomTypes.shadowRoot => DomTypes.documentFragment

Parameters

DomTypes.shadowRoot

Return type

DomTypes.documentFragment

asEventTarget

let asEventTarget: DomTypes.shadowRoot => EventTypes.eventTarget

Parameters

DomTypes.shadowRoot

Return type

EventTypes.eventTarget

asNode

let asNode: DomTypes.shadowRoot => DomTypes.node

Parameters

DomTypes.shadowRoot

Return type

DomTypes.node

cloneNode

Returns a copy of node. If deep is true, the copy also includes the node's descendants. Read more on MDN

let cloneNode: (DomTypes.shadowRoot, ~deep: bool=?) => DomTypes.shadowRoot

Parameters

DomTypes.shadowRoot option< bool >

Return type

DomTypes.shadowRoot

compareDocumentPosition

Returns a bitmask indicating the position of other relative to node. Read more on MDN

let compareDocumentPosition: (DomTypes.shadowRoot, DomTypes.node) => int

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

int

contains

Returns true if other is an inclusive descendant of node, and false otherwise. Read more on MDN

let contains: (DomTypes.shadowRoot, DomTypes.node) => bool

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

bool

dispatchEvent

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. Read more on MDN

let dispatchEvent: (DomTypes.shadowRoot, EventTypes.event) => bool

Parameters

DomTypes.shadowRoot EventTypes.event

Return type

bool

getAnimations

Read more on MDN

let getAnimations: DomTypes.shadowRoot => array<DomTypes.animation>

Parameters

DomTypes.shadowRoot

Return type

array< DomTypes.animation >

getElementById

Returns the first element within node's descendants whose ID is elementId. Read more on MDN

let getElementById: (DomTypes.shadowRoot, string) => null<DomTypes.element>

Parameters

DomTypes.shadowRoot string

Return type

Stdlib.null< DomTypes.element >

getHTML

Read more on MDN

let getHTML: (
  DomTypes.shadowRoot,
  ~options: DomTypes.getHTMLOptions=?,
) => string

Parameters

DomTypes.shadowRoot option< DomTypes.getHTMLOptions >

Return type

string

getRootNode

Returns node's root. Read more on MDN

let getRootNode: (
  DomTypes.shadowRoot,
  ~options: DomTypes.getRootNodeOptions=?,
) => DomTypes.node

Parameters

DomTypes.shadowRoot option< DomTypes.getRootNodeOptions >

Return type

DomTypes.node

hasChildNodes

Returns whether node has children. Read more on MDN

let hasChildNodes: DomTypes.shadowRoot => bool

Parameters

DomTypes.shadowRoot

Return type

bool

insertBefore

Read more on MDN

let insertBefore: (DomTypes.shadowRoot, 't, ~child: DomTypes.node) => 't

Parameters

DomTypes.shadowRoot

Return type

DomTypes.node

isDefaultNamespace

Read more on MDN

let isDefaultNamespace: (DomTypes.shadowRoot, string) => bool

Parameters

DomTypes.shadowRoot string

Return type

bool

isEqualNode

Returns whether node and otherNode have the same properties. Read more on MDN

let isEqualNode: (DomTypes.shadowRoot, DomTypes.node) => bool

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

bool

isSameNode

Read more on MDN

let isSameNode: (DomTypes.shadowRoot, DomTypes.node) => bool

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

bool

lookupNamespaceURI

Read more on MDN

let lookupNamespaceURI: (DomTypes.shadowRoot, string) => string

Parameters

DomTypes.shadowRoot string

Return type

string

lookupPrefix

Read more on MDN

let lookupPrefix: (DomTypes.shadowRoot, string) => string

Parameters

DomTypes.shadowRoot string

Return type

string

normalize

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. Read more on MDN

let normalize: DomTypes.shadowRoot => unit

Parameters

DomTypes.shadowRoot

Return type

unit

prepend

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let prepend: (DomTypes.shadowRoot, DomTypes.node) => unit

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

unit

prepend2

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let prepend2: (DomTypes.shadowRoot, string) => unit

Parameters

DomTypes.shadowRoot string

Return type

unit

querySelector

Returns the first element that is a descendant of node that matches selectors. Read more on MDN

let querySelector: (DomTypes.shadowRoot, string) => Null.t<DomTypes.element>

Parameters

DomTypes.shadowRoot string

Return type

Stdlib.Null.t< DomTypes.element >

querySelectorAll

Returns all element descendants of node that match selectors. Read more on MDN

let querySelectorAll: (
  DomTypes.shadowRoot,
  string,
) => DomTypes.nodeList<DomTypes.element>

Parameters

DomTypes.shadowRoot string

Return type

DomTypes.nodeList< DomTypes.element >

removeChild

Read more on MDN

let removeChild: (DomTypes.shadowRoot, 't) => 't

removeEventListener

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListener: (
  DomTypes.shadowRoot,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
  ~options: EventTypes.eventListenerOptions=?,
) => unit

Parameters

DomTypes.shadowRoot EventTypes.eventType EventTypes.eventListener option< EventTypes.eventListenerOptions >

Return type

unit

removeEventListenerUseCapture

Removes the event listener in target's event listener list with the same type, callback, and options. Read more on MDN

let removeEventListenerUseCapture: (
  DomTypes.shadowRoot,
  EventTypes.eventType,
  EventTypes.eventListener<'event>,
) => unit

Parameters

DomTypes.shadowRoot EventTypes.eventType EventTypes.eventListener

Return type

unit

replaceChild

Read more on MDN

let replaceChild: (DomTypes.shadowRoot, ~node: DomTypes.node, 't) => 't

Parameters

DomTypes.shadowRoot

Return type

DomTypes.node

replaceChildren

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceChildren: (DomTypes.shadowRoot, DomTypes.node) => unit

Parameters

DomTypes.shadowRoot DomTypes.node

Return type

unit

replaceChildren2

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. Read more on MDN

let replaceChildren2: (DomTypes.shadowRoot, string) => unit

Parameters

DomTypes.shadowRoot string

Return type

unit

setHTMLUnsafe

Read more on MDN

let setHTMLUnsafe: (DomTypes.shadowRoot, string) => unit

Parameters

DomTypes.shadowRoot string

Return type

unit