Interface ShadowRoot

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

    Properties

    activeElement: 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[]
    ATTRIBUTE_NODE: 2
    baseURI: string

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

    MDN Reference

    CDATA_SECTION_NODE: 4

    node is a CDATASection node.

    childElementCount: number
    childNodes: NodeListOf<ChildNode>

    Returns the children.

    MDN Reference

    children: HTMLCollection

    Returns the child elements.

    MDN Reference

    clonable: boolean
    COMMENT_NODE: 8

    node is a Comment node.

    delegatesFocus: boolean
    DOCUMENT_FRAGMENT_NODE: 11

    node is a DocumentFragment node.

    DOCUMENT_NODE: 9

    node is a document.

    DOCUMENT_POSITION_CONTAINED_BY: 16

    Set when other is a descendant of node.

    DOCUMENT_POSITION_CONTAINS: 8

    Set when other is an ancestor of node.

    DOCUMENT_POSITION_DISCONNECTED: 1

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

    DOCUMENT_POSITION_FOLLOWING: 4

    Set when other is following node.

    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
    DOCUMENT_POSITION_PRECEDING: 2

    Set when other is preceding node.

    DOCUMENT_TYPE_NODE: 10

    node is a doctype.

    ELEMENT_NODE: 1

    node is an element.

    ENTITY_NODE: 6
    ENTITY_REFERENCE_NODE: 5
    firstChild: ChildNode

    Returns the first child.

    MDN Reference

    firstElementChild: Element

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

    MDN Reference

    fullscreenElement: Element

    Returns document's fullscreen element.

    MDN Reference

    host: Element
    innerHTML: string
    isConnected: boolean

    Returns true if node is connected and false otherwise.

    MDN Reference

    lastChild: ChildNode

    Returns the last child.

    MDN Reference

    lastElementChild: Element

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

    MDN Reference

    nextSibling: 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: string
    NOTATION_NODE: 12
    onslotchange: ((this: ShadowRoot, ev: Event) => any)
    ownerDocument: Document

    Returns the node document. Returns null for documents.

    MDN Reference

    parentElement: HTMLElement

    Returns the parent element.

    MDN Reference

    parentNode: ParentNode

    Returns the parent.

    MDN Reference

    pictureInPictureElement: Element
    pointerLockElement: Element
    previousSibling: ChildNode

    Returns the previous sibling.

    MDN Reference

    PROCESSING_INSTRUCTION_NODE: 7

    node is a ProcessingInstruction node.

    serializable: boolean
    slotAssignment: SlotAssignmentMode
    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

    TEXT_NODE: 3

    node is a Text node.

    textContent: string

    Methods

    • 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

    • 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

      • Rest...nodes: (string | Node)[]

      Returns void

    • 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

    • 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

    • 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

      • Rest...nodes: (string | Node)[]

      Returns void

    • 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

      • Rest...nodes: (string | Node)[]

      Returns void

    • Parameters

      • html: string

      Returns void