Search


Search something to see results

ShadowRoot

interface ShadowRoot {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    ownerDocument: Document;
    getElementById(elementId: string): null | HTMLElement;
    activeElement: null | Element;
    adoptedStyleSheets: CSSStyleSheet[];
    fullscreenElement: null | Element;
    pictureInPictureElement: null | Element;
    pointerLockElement: null | Element;
    styleSheets: StyleSheetList;
    elementFromPoint(x: number, y: number): null | Element;
    elementsFromPoint(x: number, y: number): Element[];
    getAnimations(): Animation[];
    dispatchEvent(event: Event): boolean;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    textContent: null | string;
    appendChild<T extends Node>(node: T): T;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    removeChild<T extends Node>(child: T): T;
    replaceChild<T extends Node>(node: Node, child: T): T;
    ELEMENT_NODE: 1;
    ATTRIBUTE_NODE: 2;
    TEXT_NODE: 3;
    CDATA_SECTION_NODE: 4;
    ENTITY_REFERENCE_NODE: 5;
    ENTITY_NODE: 6;
    PROCESSING_INSTRUCTION_NODE: 7;
    COMMENT_NODE: 8;
    DOCUMENT_NODE: 9;
    DOCUMENT_TYPE_NODE: 10;
    DOCUMENT_FRAGMENT_NODE: 11;
    NOTATION_NODE: 12;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    childElementCount: number;
    children: HTMLCollection;
    firstElementChild: null | Element;
    lastElementChild: null | Element;
    append(...nodes: (string | Node)[]): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element = Element>(selectors: string): null | E;
    querySelectorAll<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<MathMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element = Element>(
        selectors: string,
    ): NodeListOf<E>;
    replaceChildren(...nodes: (string | Node)[]): void;
    clonable: boolean;
    delegatesFocus: boolean;
    host: Element;
    innerHTML: string;
    mode: ShadowRootMode;
    onslotchange: null | ((this: ShadowRoot, ev: Event) => any);
    serializable: boolean;
    slotAssignment: SlotAssignmentMode;
    getHTML(options?: GetHTMLOptions): string;
    setHTMLUnsafe(html: string): void;
    addEventListener<K extends "slotchange">(
        type: K,
        listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    removeEventListener<K extends "slotchange">(
        type: K,
        listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}

Hierarchy (View Summary)

Index

Properties

<internal>.ShadowRoot.charging<internal>.ShadowRoot.chargingTime<internal>.ShadowRoot.dischargingTime<internal>.ShadowRoot.level<internal>.ShadowRoot.ownerDocument<internal>.ShadowRoot.activeElement<internal>.ShadowRoot.adoptedStyleSheets<internal>.ShadowRoot.fullscreenElement<internal>.ShadowRoot.pictureInPictureElement<internal>.ShadowRoot.pointerLockElement<internal>.ShadowRoot.styleSheets<internal>.ShadowRoot.baseURI<internal>.ShadowRoot.childNodes<internal>.ShadowRoot.firstChild<internal>.ShadowRoot.isConnected<internal>.ShadowRoot.lastChild<internal>.ShadowRoot.nextSibling<internal>.ShadowRoot.nodeName<internal>.ShadowRoot.nodeType<internal>.ShadowRoot.nodeValue<internal>.ShadowRoot.parentElement<internal>.ShadowRoot.parentNode<internal>.ShadowRoot.previousSibling<internal>.ShadowRoot.textContent<internal>.ShadowRoot.ELEMENT_NODE<internal>.ShadowRoot.ATTRIBUTE_NODE<internal>.ShadowRoot.TEXT_NODE<internal>.ShadowRoot.CDATA_SECTION_NODE<internal>.ShadowRoot.ENTITY_REFERENCE_NODE<internal>.ShadowRoot.ENTITY_NODE<internal>.ShadowRoot.PROCESSING_INSTRUCTION_NODE<internal>.ShadowRoot.COMMENT_NODE<internal>.ShadowRoot.DOCUMENT_NODE<internal>.ShadowRoot.DOCUMENT_TYPE_NODE<internal>.ShadowRoot.DOCUMENT_FRAGMENT_NODE<internal>.ShadowRoot.NOTATION_NODE<internal>.ShadowRoot.DOCUMENT_POSITION_DISCONNECTED<internal>.ShadowRoot.DOCUMENT_POSITION_PRECEDING<internal>.ShadowRoot.DOCUMENT_POSITION_FOLLOWING<internal>.ShadowRoot.DOCUMENT_POSITION_CONTAINS<internal>.ShadowRoot.DOCUMENT_POSITION_CONTAINED_BY<internal>.ShadowRoot.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC<internal>.ShadowRoot.childElementCount<internal>.ShadowRoot.children<internal>.ShadowRoot.firstElementChild<internal>.ShadowRoot.lastElementChild<internal>.ShadowRoot.clonable<internal>.ShadowRoot.delegatesFocus<internal>.ShadowRoot.host<internal>.ShadowRoot.innerHTML<internal>.ShadowRoot.mode<internal>.ShadowRoot.onslotchange<internal>.ShadowRoot.serializable<internal>.ShadowRoot.slotAssignment

Methods

Properties

charging?: boolean
chargingTime?: number
dischargingTime?: number
level?: number
ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

activeElement: null | Element

Returns the deepest element in the document through which or to which key events are being routed. This is, roughly speaking, the focused element in the document.

For the purposes of this API, when a child browsing context is focused, its container is focused in the parent browsing context. For example, if the user moves the focus to a text control in an iframe, the iframe is the element returned by the activeElement API in the iframe's node document.

Similarly, when the focused element is in a different node tree than documentOrShadowRoot, the element returned will be the host that's located in the same node tree as documentOrShadowRoot if documentOrShadowRoot is a shadow-including inclusive ancestor of the focused element, and null if not.

MDN Reference

adoptedStyleSheets: CSSStyleSheet[]
fullscreenElement: null | Element

Returns document's fullscreen element.

MDN Reference

pictureInPictureElement: null | Element
pointerLockElement: null | Element
styleSheets: StyleSheetList

Retrieves a collection of styleSheet objects representing the style sheets that correspond to each instance of a link or style object in the document.

MDN Reference

baseURI: string

Returns node's node document's document base URL.

MDN Reference

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

firstChild: null | ChildNode

Returns the first child.

MDN Reference

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild: null | ChildNode

Returns the last child.

MDN Reference

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

nodeType: number

Returns the type of node.

MDN Reference

nodeValue: null | string
parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

parentNode: null | ParentNode

Returns the parent.

MDN Reference

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

textContent: null | string
ELEMENT_NODE: 1

node is an element.

ATTRIBUTE_NODE: 2
TEXT_NODE: 3

node is a Text node.

CDATA_SECTION_NODE: 4

node is a CDATASection node.

ENTITY_REFERENCE_NODE: 5
ENTITY_NODE: 6
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

COMMENT_NODE: 8

node is a Comment node.

DOCUMENT_NODE: 9

node is a document.

DOCUMENT_TYPE_NODE: 10

node is a doctype.

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

NOTATION_NODE: 12
DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
childElementCount: number
children: HTMLCollection

Returns the child elements.

MDN Reference

firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

MDN Reference

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

clonable: boolean
delegatesFocus: boolean
host: Element
innerHTML: string
onslotchange: null | ((this: ShadowRoot, ev: Event) => any)
serializable: boolean
slotAssignment: SlotAssignmentMode

Methods

Returns the first element within node's descendants whose ID is elementId.

MDN Reference

Parameters

  • elementId: string

Returns null | HTMLElement

Returns the element for the specified x coordinate and the specified y coordinate.

Parameters

  • x: number

    The x-offset

  • y: number

    The y-offset

Returns null | Element

Parameters

  • x: number
  • y: number

Returns Element[]

Returns Animation[]

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.

MDN Reference

Parameters

Returns boolean

Type Parameters

Parameters

  • node: T

Returns T

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

MDN Reference

Parameters

  • Optionalsubtree: boolean

Returns Node

Returns a bitmask indicating the position of other relative to node.

MDN Reference

Parameters

Returns number

Returns true if other is an inclusive descendant of node, and false otherwise.

MDN Reference

Parameters

Returns boolean

Returns node's root.

MDN Reference

Parameters

Returns Node

Returns whether node has children.

MDN Reference

Returns boolean

Type Parameters

Parameters

  • node: T
  • child: null | Node

Returns T

Parameters

  • namespace: null | string

Returns boolean

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

  • otherNode: null | Node

Returns boolean

Parameters

  • otherNode: null | Node

Returns boolean

Parameters

  • prefix: null | string

Returns null | string

Parameters

  • namespace: null | string

Returns null | string

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

MDN Reference

Returns void

Type Parameters

Parameters

  • child: T

Returns T

Type Parameters

Parameters

Returns T

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.

MDN Reference

Parameters

  • nodes: (string | Node)[]

Returns void

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.

MDN Reference

Parameters

  • nodes: (string | Node)[]

Returns void

Returns the first element that is a descendant of node that matches selectors.

MDN Reference

Type Parameters

Parameters

  • selectors: K

Returns null | HTMLElementTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | SVGElementTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | MathMLElementTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | HTMLElementDeprecatedTagNameMap[K]

Type Parameters

Parameters

  • selectors: string

Returns null | E

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<HTMLElementTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<SVGElementTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<MathMLElementTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Type Parameters

Parameters

  • selectors: string

Returns NodeListOf<E>

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.

MDN Reference

Parameters

  • nodes: (string | Node)[]

Returns void

Parameters

Returns string

Parameters

  • html: string

Returns void

Throws a "NotSupportedError" DOMException if context object is a shadow root.

Type Parameters

  • K extends "slotchange"

Parameters

Returns void

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.

MDN Reference

Parameters

Returns void

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

MDN Reference

Type Parameters

  • K extends "slotchange"

Parameters

Returns void

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

MDN Reference

Parameters

Returns void