Search

Search something to see results

GitHub

DocumentFragment

A minimal document object that has no parent. It is used as a lightweight version of Document that stores a segment of a document structure comprised of nodes just like a standard document. The key difference is that because the document fragment isn't part of the active document tree structure, changes made to the fragment don't affect the document, cause reflow, or incur any performance impact that can occur when changes are made.

MDN Reference

interface DocumentFragment {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    ownerDocument: Document;
    getElementById(elementId: string): null | HTMLElement;
    addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    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;
}

Hierarchy (View Summary)

Index

Properties

<internal>.DocumentFragment.charging<internal>.DocumentFragment.chargingTime<internal>.DocumentFragment.dischargingTime<internal>.DocumentFragment.level<internal>.DocumentFragment.ownerDocument<internal>.DocumentFragment.baseURI<internal>.DocumentFragment.childNodes<internal>.DocumentFragment.firstChild<internal>.DocumentFragment.isConnected<internal>.DocumentFragment.lastChild<internal>.DocumentFragment.nextSibling<internal>.DocumentFragment.nodeName<internal>.DocumentFragment.nodeType<internal>.DocumentFragment.nodeValue<internal>.DocumentFragment.parentElement<internal>.DocumentFragment.parentNode<internal>.DocumentFragment.previousSibling<internal>.DocumentFragment.textContent<internal>.DocumentFragment.ELEMENT_NODE<internal>.DocumentFragment.ATTRIBUTE_NODE<internal>.DocumentFragment.TEXT_NODE<internal>.DocumentFragment.CDATA_SECTION_NODE<internal>.DocumentFragment.ENTITY_REFERENCE_NODE<internal>.DocumentFragment.ENTITY_NODE<internal>.DocumentFragment.PROCESSING_INSTRUCTION_NODE<internal>.DocumentFragment.COMMENT_NODE<internal>.DocumentFragment.DOCUMENT_NODE<internal>.DocumentFragment.DOCUMENT_TYPE_NODE<internal>.DocumentFragment.DOCUMENT_FRAGMENT_NODE<internal>.DocumentFragment.NOTATION_NODE<internal>.DocumentFragment.DOCUMENT_POSITION_DISCONNECTED<internal>.DocumentFragment.DOCUMENT_POSITION_PRECEDING<internal>.DocumentFragment.DOCUMENT_POSITION_FOLLOWING<internal>.DocumentFragment.DOCUMENT_POSITION_CONTAINS<internal>.DocumentFragment.DOCUMENT_POSITION_CONTAINED_BY<internal>.DocumentFragment.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC<internal>.DocumentFragment.childElementCount<internal>.DocumentFragment.children<internal>.DocumentFragment.firstElementChild<internal>.DocumentFragment.lastElementChild

Methods

<internal>.DocumentFragment.getElementById<internal>.DocumentFragment.addEventListener<internal>.DocumentFragment.dispatchEvent<internal>.DocumentFragment.removeEventListener<internal>.DocumentFragment.appendChild<internal>.DocumentFragment.cloneNode<internal>.DocumentFragment.compareDocumentPosition<internal>.DocumentFragment.contains<internal>.DocumentFragment.getRootNode<internal>.DocumentFragment.hasChildNodes<internal>.DocumentFragment.insertBefore<internal>.DocumentFragment.isDefaultNamespace<internal>.DocumentFragment.isEqualNode<internal>.DocumentFragment.isSameNode<internal>.DocumentFragment.lookupNamespaceURI<internal>.DocumentFragment.lookupPrefix<internal>.DocumentFragment.normalize<internal>.DocumentFragment.removeChild<internal>.DocumentFragment.replaceChild<internal>.DocumentFragment.append<internal>.DocumentFragment.prepend<internal>.DocumentFragment.querySelector<internal>.DocumentFragment.querySelectorAll<internal>.DocumentFragment.replaceChildren

Properties

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

Returns the node document. Returns null for documents.

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

MDN Reference

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

MDN Reference

ELEMENT_NODE: 1

node is an element.

ATTRIBUTE_NODE: 2

ReadonlyTEXT_NODE

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

MDN Reference

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

Methods

getElementById(elementId: string): null | HTMLElement

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

MDN Reference

Parameters

  • elementId: string

Returns null | HTMLElement

addEventListener(
    type: string,
    callback: null | 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.

MDN Reference

Parameters

Returns void

dispatchEvent(event: Event): boolean

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

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void

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

MDN Reference

Parameters

Returns void

appendChild<T extends Node>(node: T): T

MDN Reference

Type Parameters

Parameters

  • node: T

Returns T

cloneNode(subtree?: boolean): Node

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

MDN Reference

Parameters

  • Optionalsubtree: boolean

Returns Node

compareDocumentPosition(other: Node): number

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

MDN Reference

Parameters

Returns number

contains(other: null | Node): boolean

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

MDN Reference

Parameters

Returns boolean

getRootNode(options?: GetRootNodeOptions): Node

Returns node's root.

MDN Reference

Parameters

Returns Node

hasChildNodes(): boolean

Returns whether node has children.

MDN Reference

Returns boolean

insertBefore<T extends Node>(node: T, child: null | Node): T

MDN Reference

Type Parameters

Parameters

  • node: T
  • child: null | Node

Returns T

isDefaultNamespace(namespace: null | string): boolean

MDN Reference

Parameters

  • namespace: null | string

Returns boolean

isEqualNode(otherNode: null | Node): boolean

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

  • otherNode: null | Node

Returns boolean

isSameNode(otherNode: null | Node): boolean

MDN Reference

Parameters

  • otherNode: null | Node

Returns boolean

lookupNamespaceURI(prefix: null | string): null | string

MDN Reference

Parameters

  • prefix: null | string

Returns null | string

lookupPrefix(namespace: null | string): null | string

MDN Reference

Parameters

  • namespace: null | string

Returns null | string

normalize(): void

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

removeChild<T extends Node>(child: T): T

MDN Reference

Type Parameters

Parameters

  • child: T

Returns T

replaceChild<T extends Node>(node: Node, child: T): T

MDN Reference

Type Parameters

Parameters

Returns T

append(...nodes: (string | Node)[]): 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

  • …nodes: (string | Node)[]

Returns void

prepend(...nodes: (string | Node)[]): 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

querySelector<K extends keyof HTMLElementTagNameMap>(
    selectors: K,
): null | HTMLElementTagNameMap[K]

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

MDN Reference

Type Parameters

Parameters

  • selectors: K

Returns null | HTMLElementTagNameMap[K]

querySelector<K extends keyof SVGElementTagNameMap>(
    selectors: K,
): null | SVGElementTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | SVGElementTagNameMap[K]

querySelector<K extends keyof MathMLElementTagNameMap>(
    selectors: K,
): null | MathMLElementTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | MathMLElementTagNameMap[K]

querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
    selectors: K,
): null | HTMLElementDeprecatedTagNameMap[K]

Type Parameters

Parameters

  • selectors: K

Returns null | HTMLElementDeprecatedTagNameMap[K]

querySelector<E extends Element = Element>(selectors: string): null | E

Type Parameters

Parameters

  • selectors: string

Returns null | E

querySelectorAll<K extends keyof HTMLElementTagNameMap>(
    selectors: K,
): NodeListOf<HTMLElementTagNameMap[K]>

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<HTMLElementTagNameMap[K]>

querySelectorAll<K extends keyof SVGElementTagNameMap>(
    selectors: K,
): NodeListOf<SVGElementTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<SVGElementTagNameMap[K]>

querySelectorAll<K extends keyof MathMLElementTagNameMap>(
    selectors: K,
): NodeListOf<MathMLElementTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<MathMLElementTagNameMap[K]>

querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
    selectors: K,
): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Type Parameters

Parameters

  • selectors: K

Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>

Type Parameters

Parameters

  • selectors: string

Returns NodeListOf<E>

replaceChildren(...nodes: (string | Node)[]): 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

  • …nodes: (string | Node)[]

Returns void