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)
- DocumentFragment
- DocumentOrShadowRoot
- ShadowRoot
Index
Properties
Methods
Properties
Optionalcharging
Optionalcharging Time
Optionaldischarging Time
Optionallevel
Readonlyowner Document
Returns the node document. Returns null for documents.
Readonlyactive 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.
adopted Style Sheets
Readonlyfullscreen Element
Returns document's fullscreen element.
Readonlypicture In Picture Element
Readonlypointer Lock Element
Readonlystyle Sheets
Retrieves a collection of styleSheet objects representing the style sheets that correspond to each instance of a link or style object in the document.
Readonlybase URI
Returns node's node document's document base URL.
Readonlychild Nodes
Returns the children.
Readonlyfirst Child
Returns the first child.
Readonlyis Connected
Returns true if node is connected and false otherwise.
Readonlylast Child
Returns the last child.
Readonlynext Sibling
Returns the next sibling.
Readonlynode Name
Returns a string appropriate for the type of node.
Readonlynode Type
Returns the type of node.
node Value
Readonlyparent Element
Returns the parent element.
Readonlyparent Node
Returns the parent.
Readonlyprevious Sibling
Returns the previous sibling.
text Content
ReadonlyELEMENT_ NODE
node is an element.
ReadonlyATTRIBUTE_ NODE
ReadonlyTEXT_ NODE
node is a Text node.
ReadonlyCDATA_ SECTION_ NODE
node is a CDATASection node.
ReadonlyENTITY_ REFERENCE_ NODE
ReadonlyENTITY_ NODE
ReadonlyPROCESSING_ INSTRUCTION_ NODE
node is a ProcessingInstruction node.
ReadonlyCOMMENT_ NODE
node is a Comment node.
ReadonlyDOCUMENT_ NODE
node is a document.
ReadonlyDOCUMENT_ TYPE_ NODE
node is a doctype.
ReadonlyDOCUMENT_ FRAGMENT_ NODE
node is a DocumentFragment node.
ReadonlyNOTATION_ NODE
ReadonlyDOCUMENT_ POSITION_ DISCONNECTED
Set when node and other are not in the same tree.
ReadonlyDOCUMENT_ POSITION_ PRECEDING
Set when other is preceding node.
ReadonlyDOCUMENT_ POSITION_ FOLLOWING
Set when other is following node.
ReadonlyDOCUMENT_ POSITION_ CONTAINS
Set when other is an ancestor of node.
ReadonlyDOCUMENT_ POSITION_ CONTAINED_ BY
Set when other is a descendant of node.
ReadonlyDOCUMENT_ POSITION_ IMPLEMENTATION_ SPECIFIC
Readonlychild Element Count
Readonlychildren
Returns the child elements.
Readonlyfirst Element Child
Returns the first child that is an element, and null otherwise.
Readonlylast Element Child
Returns the last child that is an element, and null otherwise.
Readonlyclonable
Readonlydelegates Focus
Readonlyhost
inner HTML
Readonlymode
onslotchange
Readonlyserializable
Readonlyslot Assignment
Methods
get Element By Id
getElementById(elementId: string): null | HTMLElementReturns the first element within node's descendants whose ID is elementId.
Parameters
elementId: string
Returns null | HTMLElement
element From Point
elements From Point
get Animations
dispatch Event
append Child
clone Node
compare Document Position
contains
get Root Node
getRootNode(options?: GetRootNodeOptions): Nodehas Child Nodes
hasChildNodes(): booleanReturns whether node has children.
Returns boolean
insert Before
is Default Namespace
isDefaultNamespace(namespace: null | string): booleanis Equal Node
is Same Node
isSameNode(otherNode: null | Node): booleanlookup Namespace URI
lookupNamespaceURI(prefix: null | string): null | stringlookup Prefix
lookupPrefix(namespace: null | string): null | stringnormalize
normalize(): voidRemoves empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns void
remove Child
replace Child
append
prepend
query Selector
querySelector<K extends keyof HTMLElementTagNameMap>(
selectors: K,
): null | 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 null | HTMLElementTagNameMap[K]
querySelector<K extends keyof SVGElementTagNameMap>(
selectors: K,
): null | SVGElementTagNameMap[K]Type Parameters
- K extends keyof SVGElementTagNameMap
Parameters
selectors: K
Returns null | SVGElementTagNameMap[K]
querySelector<K extends keyof MathMLElementTagNameMap>(
selectors: K,
): null | MathMLElementTagNameMap[K]Type Parameters
- K extends keyof MathMLElementTagNameMap
Parameters
selectors: K
Returns null | MathMLElementTagNameMap[K]
querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
selectors: K,
): null | HTMLElementDeprecatedTagNameMap[K]Type Parameters
- K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
selectors: K
Returns null | HTMLElementDeprecatedTagNameMap[K]
query Selector All
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]>
replace Children
get HTML
getHTML(options?: GetHTMLOptions): stringset HTML Unsafe
setHTMLUnsafe(html: string): voidadd Event Listener
addEventListener<K extends "slotchange">(
type: K,
listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidThrows a "NotSupportedError" DOMException if context object is a shadow root.
Type Parameters
- K extends "slotchange"
Parameters
type: Klistener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => anyOptionaloptions: boolean | AddEventListenerOptions
Returns void
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidAppends 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: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | AddEventListenerOptions
Returns void
remove Event Listener
removeEventListener<K extends "slotchange">(
type: K,
listener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends "slotchange"
Parameters
type: Klistener: (this: ShadowRoot, ev: ShadowRootEventMap[K]) => anyOptionaloptions: boolean | EventListenerOptions
Returns void
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Parameters
type: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | EventListenerOptions
MDN Reference