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 extends "slotchange">(
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 extends Node>(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 extends Node>(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 extends keyof HTMLElementTagNameMap>(
selectors: K,
): HTMLElementTagNameMap[K];
querySelector<K extends keyof SVGElementTagNameMap>(
selectors: K,
): SVGElementTagNameMap[K];
querySelector<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): MathMLElementTagNameMap[K];
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): HTMLElementDeprecatedTagNameMap[K];
querySelector<E extends Element = Element>(selectors: string): 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>;
removeChild<T extends Node>(child: T): T;
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;
replaceChild<T extends Node>(node: Node, child: T): T;
replaceChildren(...nodes: (string | Node)[]): void;
setHTMLUnsafe(html: string): void;
}
Hierarchy
- DocumentFragment
- DocumentOrShadowRoot
- ShadowRoot (View Summary)
Index
Properties
Methods
Properties
Readonly
activeElement
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.
adoptedStyleSheets
Readonly
ATTRIBUTE_NODE
Readonly
baseURI
Returns node's node document's document base URL.
Readonly
CDATA_SECTION_NODE
node is a CDATASection node.
Readonly
childElementCount
Readonly
childNodes
Returns the children.
Readonly
children
Returns the child elements.
Readonly
clonable
Readonly
COMMENT_NODE
node is a Comment node.
Readonly
delegatesFocus
Readonly
DOCUMENT_FRAGMENT_NODE
node is a DocumentFragment node.
Readonly
DOCUMENT_NODE
node is a document.
Readonly
DOCUMENT_POSITION_CONTAINED_BY
Set when other is a descendant of node.
Readonly
DOCUMENT_POSITION_CONTAINS
Set when other is an ancestor of node.
Readonly
DOCUMENT_POSITION_DISCONNECTED
Set when node and other are not in the same tree.
Readonly
DOCUMENT_POSITION_FOLLOWING
Set when other is following node.
Readonly
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
Readonly
DOCUMENT_POSITION_PRECEDING
Set when other is preceding node.
Readonly
DOCUMENT_TYPE_NODE
node is a doctype.
Readonly
ELEMENT_NODE
node is an element.
Readonly
ENTITY_NODE
Readonly
ENTITY_REFERENCE_NODE
Readonly
firstChild
Returns the first child.
Readonly
firstElementChild
Returns the first child that is an element, and null otherwise.
Readonly
fullscreenElement
Returns document's fullscreen element.
Readonly
host
innerHTML
Readonly
isConnected
Returns true if node is connected and false otherwise.
Readonly
lastChild
Returns the last child.
Readonly
lastElementChild
Returns the last child that is an element, and null otherwise.
Readonly
mode
Readonly
nextSibling
Returns the next sibling.
Readonly
nodeName
Returns a string appropriate for the type of node.
Readonly
nodeType
Returns the type of node.
nodeValue
Readonly
NOTATION_NODE
onslotchange
Readonly
ownerDocument
Returns the node document. Returns null for documents.
Readonly
parentElement
Returns the parent element.
Readonly
parentNode
Returns the parent.
Readonly
pictureInPictureElement
Readonly
pointerLockElement
Readonly
previousSibling
Returns the previous sibling.
Readonly
PROCESSING_INSTRUCTION_NODE
node is a ProcessingInstruction node.
Readonly
serializable
Readonly
slotAssignment
Readonly
styleSheets
Retrieves a collection of styleSheet objects representing the style sheets that correspond to each instance of a link or style object in the document.
Readonly
TEXT_NODE
node is a Text node.
textContent
Methods
addEventListener
- addEventListener<K extends "slotchange">(
type: K,
listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): void Throws a "NotSupportedError" DOMException if context object is a shadow root.
Type Parameters
Parameters
- type: K
- listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any
Optional
options: boolean | AddEventListenerOptions
Returns void
- addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): 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.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optional
options: boolean | AddEventListenerOptions
Returns void
append
appendChild
cloneNode
compareDocumentPosition
contains
dispatchEvent
elementFromPoint
elementsFromPoint
getAnimations
getElementById
- getElementById(elementId: string): HTMLElement
Returns the first element within node's descendants whose ID is elementId.
Parameters
- elementId: string
Returns HTMLElement
getHTML
- getHTML(options?: GetHTMLOptions): string
Parameters
Optional
options: GetHTMLOptions
Returns string
getRootNode
- getRootNode(options?: GetRootNodeOptions): Node
Returns node's root.
Parameters
Optional
options: GetRootNodeOptions
Returns Node
hasChildNodes
insertBefore
isDefaultNamespace
isEqualNode
isSameNode
lookupNamespaceURI
lookupPrefix
normalize
prepend
querySelector
- querySelector<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): HTMLElementTagNameMap[K] Returns the first element that is a descendant of node that matches selectors.
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns HTMLElementTagNameMap[K]
- querySelector<K extends keyof SVGElementTagNameMap>(
selectors: K,
): SVGElementTagNameMap[K] Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns SVGElementTagNameMap[K]
- querySelector<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): MathMLElementTagNameMap[K] Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns MathMLElementTagNameMap[K]
- querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): HTMLElementDeprecatedTagNameMap[K] Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns HTMLElementDeprecatedTagNameMap[K]
- querySelector<E extends Element = Element>(selectors: string): E
Type Parameters
Parameters
- selectors: string
Returns E
querySelectorAll
- querySelectorAll<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementTagNameMap[K]> Returns all element descendants of node that match selectors.
Type Parameters
- K extends keyof HTMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementTagNameMap[K]>
- querySelectorAll<K extends keyof SVGElementTagNameMap>(
selectors: K,
): NodeListOf<SVGElementTagNameMap[K]> Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<SVGElementTagNameMap[K]>
- querySelectorAll<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): NodeListOf<MathMLElementTagNameMap[K]> Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
- selectors: K
Returns NodeListOf<MathMLElementTagNameMap[K]>
- querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): NodeListOf<HTMLElementDeprecatedTagNameMap[K]> Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
- selectors: K
Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
- querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>
Type Parameters
Parameters
- selectors: string
Returns NodeListOf<E>
removeChild
removeEventListener
- removeEventListener<K extends "slotchange">(
type: K,
listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): void Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
Parameters
- type: K
- listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any
Optional
options: boolean | EventListenerOptions
Returns void
- removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): void Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optional
options: boolean | EventListenerOptions
Returns void
MDN Reference