Element is the most general base class from which all objects in a Document inherit. It only has methods and properties common to all kinds of elements. More specific classes inherit from Element.

MDN Reference

interface Element {
    ariaAtomic: null | string;
    ariaAutoComplete: null | string;
    ariaBrailleLabel: null | string;
    ariaBrailleRoleDescription: null | string;
    ariaBusy: null | string;
    ariaChecked: null | string;
    ariaColCount: null | string;
    ariaColIndex: null | string;
    ariaColSpan: null | string;
    ariaCurrent: null | string;
    ariaDescription: null | string;
    ariaDisabled: null | string;
    ariaExpanded: null | string;
    ariaHasPopup: null | string;
    ariaHidden: null | string;
    ariaInvalid: null | string;
    ariaKeyShortcuts: null | string;
    ariaLabel: null | string;
    ariaLevel: null | string;
    ariaLive: null | string;
    ariaModal: null | string;
    ariaMultiLine: null | string;
    ariaMultiSelectable: null | string;
    ariaOrientation: null | string;
    ariaPlaceholder: null | string;
    ariaPosInSet: null | string;
    ariaPressed: null | string;
    ariaReadOnly: null | string;
    ariaRequired: null | string;
    ariaRoleDescription: null | string;
    ariaRowCount: null | string;
    ariaRowIndex: null | string;
    ariaRowSpan: null | string;
    ariaSelected: null | string;
    ariaSetSize: null | string;
    ariaSort: null | string;
    ariaValueMax: null | string;
    ariaValueMin: null | string;
    ariaValueNow: null | string;
    ariaValueText: null | string;
    assignedSlot: null | HTMLSlotElement;
    ATTRIBUTE_NODE: 2;
    attributes: NamedNodeMap;
    baseURI: string;
    CDATA_SECTION_NODE: 4;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    classList: DOMTokenList;
    className: string;
    clientHeight: number;
    clientLeft: number;
    clientTop: number;
    clientWidth: number;
    COMMENT_NODE: 8;
    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: null | ChildNode;
    firstElementChild: null | Element;
    id: string;
    innerHTML: string;
    isConnected: boolean;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    localName: string;
    namespaceURI: null | string;
    nextElementSibling: null | Element;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    NOTATION_NODE: 12;
    onfullscreenchange: null | ((this: Element, ev: Event) => any);
    onfullscreenerror: null | ((this: Element, ev: Event) => any);
    outerHTML: string;
    ownerDocument: Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    part: DOMTokenList;
    prefix: null | string;
    previousElementSibling: null | Element;
    previousSibling: null | ChildNode;
    PROCESSING_INSTRUCTION_NODE: 7;
    role: null | string;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
    scrollWidth: number;
    shadowRoot: null | ShadowRoot;
    slot: string;
    tagName: string;
    TEXT_NODE: 3;
    textContent: null | string;
    addEventListener<K>(type: K, listener: ((this: Element, ev: ElementEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    after(...nodes: (string | Node)[]): void;
    animate(keyframes: null | PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
    append(...nodes: (string | Node)[]): void;
    appendChild<T>(node: T): T;
    attachShadow(init: ShadowRootInit): ShadowRoot;
    before(...nodes: (string | Node)[]): void;
    checkVisibility(options?: CheckVisibilityOptions): boolean;
    cloneNode(deep?: boolean): Node;
    closest<K>(selector: K): null | HTMLElementTagNameMap[K];
    closest<K>(selector: K): null | SVGElementTagNameMap[K];
    closest<K>(selector: K): null | MathMLElementTagNameMap[K];
    closest<E>(selectors: string): null | E;
    compareDocumentPosition(other: Node): number;
    computedStyleMap(): StylePropertyMapReadOnly;
    contains(other: null | Node): boolean;
    dispatchEvent(event: Event): boolean;
    getAnimations(options?: GetAnimationsOptions): Animation[];
    getAttribute(qualifiedName: string): null | string;
    getAttributeNames(): string[];
    getAttributeNode(qualifiedName: string): null | Attr;
    getAttributeNodeNS(namespace: null | string, localName: string): null | Attr;
    getAttributeNS(namespace: null | string, localName: string): null | string;
    getBoundingClientRect(): DOMRect;
    getClientRects(): DOMRectList;
    getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
    getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
    getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
    getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
    getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
    getElementsByTagNameNS(namespace: null | string, localName: string): HTMLCollectionOf<Element>;
    getHTML(options?: GetHTMLOptions): string;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasAttribute(qualifiedName: string): boolean;
    hasAttributeNS(namespace: null | string, localName: string): boolean;
    hasAttributes(): boolean;
    hasChildNodes(): boolean;
    hasPointerCapture(pointerId: number): boolean;
    insertAdjacentElement(where: InsertPosition, element: Element): null | Element;
    insertAdjacentHTML(position: InsertPosition, string: string): void;
    insertAdjacentText(where: InsertPosition, data: string): void;
    insertBefore<T>(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;
    matches(selectors: string): boolean;
    normalize(): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K];
    querySelector<K>(selectors: K): null | SVGElementTagNameMap[K];
    querySelector<K>(selectors: K): null | MathMLElementTagNameMap[K];
    querySelector<K>(selectors: K): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E>(selectors: string): null | 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>;
    releasePointerCapture(pointerId: number): void;
    remove(): void;
    removeAttribute(qualifiedName: string): void;
    removeAttributeNode(attr: Attr): Attr;
    removeAttributeNS(namespace: null | string, localName: string): void;
    removeChild<T>(child: T): T;
    removeEventListener<K>(type: K, listener: ((this: Element, ev: ElementEventMap[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;
    replaceWith(...nodes: (string | Node)[]): void;
    requestFullscreen(options?: FullscreenOptions): Promise<void>;
    requestPointerLock(options?: PointerLockOptions): Promise<void>;
    scroll(options?: ScrollToOptions): void;
    scroll(x: number, y: number): void;
    scrollBy(options?: ScrollToOptions): void;
    scrollBy(x: number, y: number): void;
    scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
    scrollTo(options?: ScrollToOptions): void;
    scrollTo(x: number, y: number): void;
    setAttribute(qualifiedName: string, value: string): void;
    setAttributeNode(attr: Attr): null | Attr;
    setAttributeNodeNS(attr: Attr): null | Attr;
    setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void;
    setHTMLUnsafe(html: string): void;
    setPointerCapture(pointerId: number): void;
    toggleAttribute(qualifiedName: string, force?: boolean): boolean;
    webkitMatchesSelector(selectors: string): boolean;
}

Hierarchy (view full)

Properties

Methods

Properties

ariaAtomic: null | string
ariaAutoComplete: null | string
ariaBrailleLabel: null | string
ariaBrailleRoleDescription: null | string
ariaBusy: null | string
ariaChecked: null | string
ariaColCount: null | string
ariaColIndex: null | string
ariaColSpan: null | string
ariaCurrent: null | string
ariaDescription: null | string
ariaDisabled: null | string
ariaExpanded: null | string
ariaHasPopup: null | string
ariaHidden: null | string
ariaInvalid: null | string
ariaKeyShortcuts: null | string
ariaLabel: null | string
ariaLevel: null | string
ariaLive: null | string
ariaModal: null | string
ariaMultiLine: null | string
ariaMultiSelectable: null | string
ariaOrientation: null | string
ariaPlaceholder: null | string
ariaPosInSet: null | string
ariaPressed: null | string
ariaReadOnly: null | string
ariaRequired: null | string
ariaRoleDescription: null | string
ariaRowCount: null | string
ariaRowIndex: null | string
ariaRowSpan: null | string
ariaSelected: null | string
ariaSetSize: null | string
ariaSort: null | string
ariaValueMax: null | string
ariaValueMin: null | string
ariaValueNow: null | string
ariaValueText: null | string
assignedSlot: null | HTMLSlotElement
ATTRIBUTE_NODE
attributes: NamedNodeMap
baseURI: string

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

MDN Reference

CDATA_SECTION_NODE

node is a CDATASection node.

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

children: HTMLCollection

Returns the child elements.

MDN Reference

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

className: string

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
COMMENT_NODE

node is a Comment node.

DOCUMENT_FRAGMENT_NODE

node is a DocumentFragment node.

DOCUMENT_NODE

node is a document.

DOCUMENT_POSITION_CONTAINED_BY

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED

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

DOCUMENT_POSITION_FOLLOWING

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_PRECEDING

Set when other is preceding node.

DOCUMENT_TYPE_NODE

node is a doctype.

ELEMENT_NODE

node is an element.

ENTITY_NODE
ENTITY_REFERENCE_NODE
firstChild: null | ChildNode

Returns the first child.

MDN Reference

firstElementChild: null | Element

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

MDN Reference

id: string

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

innerHTML: string
isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild: null | ChildNode

Returns the last child.

MDN Reference

lastElementChild: null | Element

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

MDN Reference

localName: string

Returns the local name.

MDN Reference

namespaceURI: null | string

Returns the namespace.

MDN Reference

nextElementSibling: null | Element

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

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
NOTATION_NODE
onfullscreenchange: null | ((this: Element, ev: Event) => any)
onfullscreenerror: null | ((this: Element, ev: Event) => any)
outerHTML: string
ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

parentNode: null | ParentNode

Returns the parent.

MDN Reference

part: DOMTokenList
prefix: null | string

Returns the namespace prefix.

MDN Reference

previousElementSibling: null | Element

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

MDN Reference

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

PROCESSING_INSTRUCTION_NODE

node is a ProcessingInstruction node.

role: null | string
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

TEXT_NODE

node is a Text node.

textContent: null | string

Methods

  • 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

    Type Parameters

    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 just after 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

  • 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

  • Inserts nodes just before 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

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

    MDN Reference

    Parameters

    • Optionaldeep: boolean

    Returns Node

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

    MDN Reference

    Parameters

    Returns number

  • Returns StylePropertyMapReadOnly

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

    MDN Reference

    Parameters

    Returns 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

    • event: Event

    Returns boolean

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | string

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    MDN Reference

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns null | Attr

  • Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

  • Returns DOMRectList

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

    Returns string

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

  • Returns true if element has attributes, and false otherwise.

    MDN Reference

    Returns boolean

  • Returns whether node has children.

    MDN Reference

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    Returns void

  • Parameters

    Returns void

  • 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

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    MDN Reference

    Parameters

    • selectors: string

    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

  • Parameters

    • pointerId: number

    Returns void

  • Removes node.

    MDN Reference

    Returns void

  • Removes element's first attribute whose qualified name is qualifiedName.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

  • Parameters

    Returns Attr

  • Removes element's attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    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

  • Replaces 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

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    MDN Reference

    Parameters

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    MDN Reference

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    Returns null | Attr

  • Parameters

    Returns null | Attr

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    MDN Reference

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    • html: string

    Returns void

  • Parameters

    • pointerId: number

    Returns void

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

  • Parameters

    • selectors: string

    Returns boolean

    This is a legacy alias of matches.

    MDN Reference