• Overview
@angular/elements

NgElement

Class
stable

Implements the functionality needed for a custom element.

API

    
      abstract class NgElement extends HTMLElement {
}

ngElementStrategy

NgElementStrategy

The strategy that controls how a component is transformed in a custom element.

ngElementEventsSubscription

any

A subscription to change, connect, and disconnect events in the custom element.

attributeChangedCallback

void

Prototype for a handler that responds to a change in an observed attribute.

@paramattrNamestring

The name of the attribute that has changed.

@paramoldValuestring | null

The previous value of the attribute.

@paramnewValuestring

The new value of the attribute.

@paramnamespacestring | undefined

The namespace in which the attribute is defined.

@returnsvoid

connectedCallback

void

Prototype for a handler that responds to the insertion of the custom element in the DOM.

@returnsvoid

disconnectedCallback

void

Prototype for a handler that responds to the deletion of the custom element from the DOM.

@returnsvoid

accessKey

string

The HTMLElement.accessKey property sets the keystroke which a user can press to jump to a given element.

MDN Reference

accessKeyLabel

string

The HTMLElement.accessKeyLabel read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.

MDN Reference

autocapitalize

string

The autocapitalize property of the HTMLElement interface represents the element's capitalization behavior for user input.

MDN Reference

autocorrect

boolean

The autocorrect property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.

MDN Reference

dir

string

The HTMLElement.dir property indicates the text writing directionality of the content of the current element.

MDN Reference

draggable

boolean

The draggable property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.

MDN Reference

hidden

boolean

The HTMLElement property hidden reflects the value of the element's hidden attribute.

MDN Reference

inert

boolean

The HTMLElement property inert reflects the value of the element's inert attribute.

MDN Reference

innerText

string

The innerText property of the HTMLElement interface represents the rendered text content of a node and its descendants.

MDN Reference

lang

string

The lang property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].

MDN Reference

offsetHeight

number

The offsetHeight read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.

MDN Reference

offsetLeft

number

The offsetLeft read-only property of the HTMLElement interface returns the number of pixels that the upper left corner of the current element is offset to the left within the HTMLElement.offsetParent node.

MDN Reference

offsetParent

Element | null

The HTMLElement.offsetParent read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.

MDN Reference

offsetTop

number

The offsetTop read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the closest positioned ancestor element.

MDN Reference

offsetWidth

number

The offsetWidth read-only property of the HTMLElement interface returns the layout width of an element as an integer.

MDN Reference

outerText

string

The outerText property of the HTMLElement interface returns the same value as HTMLElement.innerText.

MDN Reference

popover

string | null

The popover property of the HTMLElement interface gets and sets an element's popover state via JavaScript ('auto', 'hint', or 'manual'), and can be used for feature detection.

MDN Reference

spellcheck

boolean

The spellcheck property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.

MDN Reference

title

string

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

MDN Reference

translate

boolean

The translate property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.

MDN Reference

writingSuggestions

string

The writingSuggestions property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.

MDN Reference

attachInternals

ElementInternals

The HTMLElement.attachInternals() method returns an ElementInternals object.

MDN Reference

@returnsElementInternals

click

void

The HTMLElement.click() method simulates a mouse click on an element.

MDN Reference

@returnsvoid

hidePopover

void

The hidePopover() method of the HTMLElement interface hides a popover element (i.e., one that has a valid popover attribute) by removing it from the top layer and styling it with display: none.

MDN Reference

@returnsvoid

showPopover

void

The showPopover() method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid popover attribute) by adding it to the top layer.

MDN Reference

@returnsvoid

togglePopover

boolean

The togglePopover() method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid popover attribute) between the hidden and showing states.

MDN Reference

@paramoptionsboolean | undefined
@returnsboolean

addEventListener

void
@paramtypeK
@paramlistener(this: HTMLElement, ev: HTMLElementEventMap[K]) => any
@paramoptionsboolean | AddEventListenerOptions | undefined
@returnsvoid

addEventListener

void
@paramtypestring
@paramlistenerEventListenerOrEventListenerObject
@paramoptionsboolean | AddEventListenerOptions | undefined
@returnsvoid

removeEventListener

void
@paramtypeK
@paramlistener(this: HTMLElement, ev: HTMLElementEventMap[K]) => any
@paramoptionsboolean | EventListenerOptions | undefined
@returnsvoid

removeEventListener

void
@paramtypestring
@paramlistenerEventListenerOrEventListenerObject
@paramoptionsboolean | EventListenerOptions | undefined
@returnsvoid

attributes

NamedNodeMap

The Element.attributes property returns a live collection of all attribute nodes registered to the specified node.

MDN Reference

classList

DOMTokenList

The Element.classList is a read-only property that returns a live DOMTokenList collection of the class attributes of the element.

MDN Reference

classList

DOMTokenList

className

string

The className property of the of the specified element.

MDN Reference

clientHeight

number

The clientHeight read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.

MDN Reference

clientLeft

number

The clientLeft read-only property of the Element interface returns the width of the left border of an element in pixels.

MDN Reference

clientTop

number

The clientTop read-only property of the Element interface returns the width of the top border of an element in pixels.

MDN Reference

clientWidth

number

The clientWidth read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.

MDN Reference

currentCSSZoom

number

The currentCSSZoom read-only property of the Element interface provides the 'effective' CSS zoom of an element, taking into account the zoom applied to the element and all its parent elements.

MDN Reference

id

string

The id property of the Element interface represents the element's identifier, reflecting the id global attribute.

MDN Reference

innerHTML

string

The innerHTML property of the Element interface gets or sets the HTML or XML markup contained within the element.

MDN Reference

localName

string

The Element.localName read-only property returns the local part of the qualified name of an element.

MDN Reference

namespaceURI

string | null

The Element.namespaceURI read-only property returns the namespace URI of the element, or null if the element is not in a namespace.

MDN Reference

onfullscreenchange

((this: Element, ev: Event) => any) | null

onfullscreenerror

((this: Element, ev: Event) => any) | null

outerHTML

string

The outerHTML attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.

MDN Reference

ownerDocument

Document

part

DOMTokenList

The part property of the Element interface represents the part identifier(s) of the element (i.e., set using the part attribute), returned as a DOMTokenList.

MDN Reference

part

DOMTokenList

prefix

string | null

The Element.prefix read-only property returns the namespace prefix of the specified element, or null if no prefix is specified.

MDN Reference

scrollHeight

number

The scrollHeight read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.

MDN Reference

scrollLeft

number

The scrollLeft property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.

MDN Reference

scrollTop

number

The scrollTop property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.

MDN Reference

scrollWidth

number

The scrollWidth read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.

MDN Reference

shadowRoot

ShadowRoot | null

The Element.shadowRoot read-only property represents the shadow root hosted by the element.

MDN Reference

slot

string

The slot property of the Element interface returns the name of the shadow DOM slot the element is inserted in.

MDN Reference

tagName

string

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference

attachShadow

ShadowRoot

The Element.attachShadow() method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.

MDN Reference

@paraminitShadowRootInit
@returnsShadowRoot

checkVisibility

boolean

The checkVisibility() method of the Element interface checks whether the element is visible.

MDN Reference

@paramoptionsCheckVisibilityOptions | undefined
@returnsboolean

closest

HTMLElementTagNameMap[K] | null

The closest() method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.

MDN Reference

@paramselectorK
@returnsHTMLElementTagNameMap[K] | null

closest

SVGElementTagNameMap[K] | null
@paramselectorK
@returnsSVGElementTagNameMap[K] | null

closest

MathMLElementTagNameMap[K] | null
@paramselectorK
@returnsMathMLElementTagNameMap[K] | null

closest

E | null
@paramselectorsstring
@returnsE | null

computedStyleMap

StylePropertyMapReadOnly

The computedStyleMap() method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.

MDN Reference

@returnsStylePropertyMapReadOnly

getAttribute

string | null

The getAttribute() method of the element.

MDN Reference

@paramqualifiedNamestring
@returnsstring | null

getAttributeNS

string | null

The getAttributeNS() method of the Element interface returns the string value of the attribute with the specified namespace and name.

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsstring | null

getAttributeNames

string[]

The getAttributeNames() method of the array.

MDN Reference

@returnsstring[]

getAttributeNode

Attr | null

Returns the specified attribute of the specified element, as an Attr node.

MDN Reference

@paramqualifiedNamestring
@returnsAttr | null

getAttributeNodeNS

Attr | null

The getAttributeNodeNS() method of the Element interface returns the namespaced Attr node of an element.

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsAttr | null

getBoundingClientRect

DOMRect

The Element.getBoundingClientRect() method returns a position relative to the viewport.

MDN Reference

@returnsDOMRect

getClientRects

DOMRectList

The getClientRects() method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.

MDN Reference

@returnsDOMRectList

getElementsByClassName

HTMLCollectionOf<Element>

The Element method getElementsByClassName() returns a live specified class name or names.

MDN Reference

@paramclassNamesstring
@returnsHTMLCollectionOf<Element>

getElementsByTagName

HTMLCollectionOf<HTMLElementTagNameMap[K]>

The Element.getElementsByTagName() method returns a live All descendants of the specified element are searched, but not the element itself.

MDN Reference

@paramqualifiedNameK
@returnsHTMLCollectionOf<HTMLElementTagNameMap[K]>

getElementsByTagName

HTMLCollectionOf<SVGElementTagNameMap[K]>
@paramqualifiedNameK
@returnsHTMLCollectionOf<SVGElementTagNameMap[K]>

getElementsByTagName

HTMLCollectionOf<MathMLElementTagNameMap[K]>
@paramqualifiedNameK
@returnsHTMLCollectionOf<MathMLElementTagNameMap[K]>

getElementsByTagName

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
@deprecated
@paramqualifiedNameK
@returnsHTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

getElementsByTagName

HTMLCollectionOf<Element>
@paramqualifiedNamestring
@returnsHTMLCollectionOf<Element>

getElementsByTagNameNS

HTMLCollectionOf<HTMLElement>

The Element.getElementsByTagNameNS() method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.

MDN Reference

@paramnamespaceURI"http://www.w3.org/1999/xhtml"
@paramlocalNamestring
@returnsHTMLCollectionOf<HTMLElement>

getElementsByTagNameNS

HTMLCollectionOf<SVGElement>
@paramnamespaceURI"http://www.w3.org/2000/svg"
@paramlocalNamestring
@returnsHTMLCollectionOf<SVGElement>

getElementsByTagNameNS

HTMLCollectionOf<MathMLElement>
@paramnamespaceURI"http://www.w3.org/1998/Math/MathML"
@paramlocalNamestring
@returnsHTMLCollectionOf<MathMLElement>

getElementsByTagNameNS

HTMLCollectionOf<Element>
@paramnamespacestring | null
@paramlocalNamestring
@returnsHTMLCollectionOf<Element>

getHTML

string

The getHTML() method of the Element interface is used to serialize an element's DOM to an HTML string.

MDN Reference

@paramoptionsGetHTMLOptions | undefined
@returnsstring

hasAttribute

boolean

The Element.hasAttribute() method returns a Boolean value indicating whether the specified element has the specified attribute or not.

MDN Reference

@paramqualifiedNamestring
@returnsboolean

hasAttributeNS

boolean

The hasAttributeNS() method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsboolean

hasAttributes

boolean

The hasAttributes() method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.

MDN Reference

@returnsboolean

hasPointerCapture

boolean

The hasPointerCapture() method of the pointer capture for the pointer identified by the given pointer ID.

MDN Reference

@parampointerIdnumber
@returnsboolean

insertAdjacentElement

Element | null

The insertAdjacentElement() method of the relative to the element it is invoked upon.

MDN Reference

@paramwhereInsertPosition
@paramelementElement
@returnsElement | null

insertAdjacentHTML

void

The insertAdjacentHTML() method of the the resulting nodes into the DOM tree at a specified position.

MDN Reference

@parampositionInsertPosition
@paramstringstring
@returnsvoid

insertAdjacentText

void

The insertAdjacentText() method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.

MDN Reference

@paramwhereInsertPosition
@paramdatastring
@returnsvoid

matches

boolean

The matches() method of the Element interface tests whether the element would be selected by the specified CSS selector.

MDN Reference

@paramselectorsstring
@returnsboolean

releasePointerCapture

void

The releasePointerCapture() method of the previously set for a specific (PointerEvent) pointer.

MDN Reference

@parampointerIdnumber
@returnsvoid

removeAttribute

void

The Element method removeAttribute() removes the attribute with the specified name from the element.

MDN Reference

@paramqualifiedNamestring
@returnsvoid

removeAttributeNS

void

The removeAttributeNS() method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsvoid

removeAttributeNode

Attr

The removeAttributeNode() method of the Element interface removes the specified Attr node from the element.

MDN Reference

@paramattrAttr
@returnsAttr

requestFullscreen

Promise<void>

The Element.requestFullscreen() method issues an asynchronous request to make the element be displayed in fullscreen mode.

MDN Reference

@paramoptionsFullscreenOptions | undefined
@returnsPromise<void>

requestPointerLock

Promise<void>

The requestPointerLock() method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.

MDN Reference

@paramoptionsPointerLockOptions | undefined
@returnsPromise<void>

scroll

void

The scroll() method of the Element interface scrolls the element to a particular set of coordinates inside a given element.

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scroll

void
@paramxnumber
@paramynumber
@returnsvoid

scrollBy

void

The scrollBy() method of the Element interface scrolls an element by the given amount.

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scrollBy

void
@paramxnumber
@paramynumber
@returnsvoid

scrollIntoView

void

The Element interface's scrollIntoView() method scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

MDN Reference

@paramargboolean | ScrollIntoViewOptions | undefined
@returnsvoid

scrollTo

void

The scrollTo() method of the Element interface scrolls to a particular set of coordinates inside a given element.

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scrollTo

void
@paramxnumber
@paramynumber
@returnsvoid

setAttribute

void

The setAttribute() method of the Element interface sets the value of an attribute on the specified element.

MDN Reference

@paramqualifiedNamestring
@paramvaluestring
@returnsvoid

setAttributeNS

void

setAttributeNS adds a new attribute or changes the value of an attribute with the given namespace and name.

MDN Reference

@paramnamespacestring | null
@paramqualifiedNamestring
@paramvaluestring
@returnsvoid

setAttributeNode

Attr | null

The setAttributeNode() method of the Element interface adds a new Attr node to the specified element.

MDN Reference

@paramattrAttr
@returnsAttr | null

setAttributeNodeNS

Attr | null

The setAttributeNodeNS() method of the Element interface adds a new namespaced Attr node to an element.

MDN Reference

@paramattrAttr
@returnsAttr | null

setHTMLUnsafe

void

The setHTMLUnsafe() method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.

MDN Reference

@paramhtmlstring
@returnsvoid

setPointerCapture

void

The setPointerCapture() method of the capture target of future pointer events.

MDN Reference

@parampointerIdnumber
@returnsvoid

toggleAttribute

boolean

The toggleAttribute() method of the present and adding it if it is not present) on the given element.

MDN Reference

@paramqualifiedNamestring
@paramforceboolean | undefined
@returnsboolean

webkitMatchesSelector

boolean
@deprecated

This is a legacy alias of matches.

MDN Reference

@paramselectorsstring
@returnsboolean

textContent

string

textContent

string

baseURI

string

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

MDN Reference

childNodes

NodeListOf<ChildNode>

The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.

MDN Reference

firstChild

ChildNode | null

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

MDN Reference

isConnected

boolean

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

MDN Reference

lastChild

ChildNode | null

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

MDN Reference

nextSibling

ChildNode | null

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns null if the specified node is the last child in the parent element.

MDN Reference

nodeName

string

The read-only nodeName property of Node returns the name of the current node as a string.

MDN Reference

nodeType

number

The read-only nodeType property of a Node interface is an integer that identifies what the node is.

MDN Reference

nodeValue

string | null

The nodeValue property of the Node interface returns or sets the value of the current node.

MDN Reference

parentElement

HTMLElement | null

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element.

MDN Reference

parentNode

ParentNode | null

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

MDN Reference

previousSibling

ChildNode | null

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's or null if the specified node is the first in that list.

MDN Reference

appendChild

T

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

MDN Reference

@paramnodeT
@returnsT

cloneNode

Node

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called.

MDN Reference

@paramsubtreeboolean | undefined
@returnsNode

compareDocumentPosition

number

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

MDN Reference

@paramotherNode
@returnsnumber

contains

boolean

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.

MDN Reference

@paramotherNode | null
@returnsboolean

getRootNode

Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

MDN Reference

@paramoptionsGetRootNodeOptions | undefined
@returnsNode

hasChildNodes

boolean

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

MDN Reference

@returnsboolean

insertBefore

T

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

MDN Reference

@paramnodeT
@paramchildNode | null
@returnsT

isDefaultNamespace

boolean

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

MDN Reference

@paramnamespacestring | null
@returnsboolean

isEqualNode

boolean

The isEqualNode() method of the Node interface tests whether two nodes are equal.

MDN Reference

@paramotherNodeNode | null
@returnsboolean

isSameNode

boolean

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

MDN Reference

@paramotherNodeNode | null
@returnsboolean

lookupNamespaceURI

string | null

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not).

MDN Reference

@paramprefixstring | null
@returnsstring | null

lookupPrefix

string | null

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not.

MDN Reference

@paramnamespacestring | null
@returnsstring | null

normalize

void

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form.

MDN Reference

@returnsvoid

removeChild

T

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

MDN Reference

@paramchildT
@returnsT

replaceChild

T

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

MDN Reference

@paramnodeNode
@paramchildT
@returnsT

ELEMENT_NODE

1

node is an element.

ATTRIBUTE_NODE

2

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

dispatchEvent

boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

@parameventEvent
@returnsboolean

removeAllListeners

void

Remove all event listeners by name for this event target.

This method is optional because it may not be available if you use noop zone when bootstrapping Angular application or disable the EventTarget monkey patch by zone.js.

If the eventName is provided, will remove event listeners of that name. If the eventName is not provided, will remove all event listeners associated with EventTarget.

@parameventNamestring | undefined

the name of the event, such as click. This parameter is optional.

@returnsvoid

eventListeners

EventListenerOrEventListenerObject[]

Retrieve all event listeners by name.

This method is optional because it may not be available if you use noop zone when bootstrapping Angular application or disable the EventTarget monkey patch by zone.js.

If the eventName is provided, will return an array of event handlers or event listener objects of the given event. If the eventName is not provided, will return all listeners.

@parameventNamestring | undefined

the name of the event, such as click. This parameter is optional.

@returnsEventListenerOrEventListenerObject[]

ariaActiveDescendantElement

Element | null

ariaAtomic

string | null

ariaAutoComplete

string | null

ariaBrailleLabel

string | null

ariaBrailleRoleDescription

string | null

ariaBusy

string | null

ariaChecked

string | null

ariaColCount

string | null

ariaColIndex

string | null

ariaColIndexText

string | null

ariaColSpan

string | null

ariaControlsElements

readonly Element[] | null

ariaCurrent

string | null

ariaDescribedByElements

readonly Element[] | null

ariaDescription

string | null

ariaDetailsElements

readonly Element[] | null

ariaDisabled

string | null

ariaErrorMessageElements

readonly Element[] | null

ariaExpanded

string | null

ariaFlowToElements

readonly Element[] | null

ariaHasPopup

string | null

ariaHidden

string | null

ariaInvalid

string | null

ariaKeyShortcuts

string | null

ariaLabel

string | null

ariaLabelledByElements

readonly Element[] | null

ariaLevel

string | null

ariaLive

string | null

ariaModal

string | null

ariaMultiLine

string | null

ariaMultiSelectable

string | null

ariaOrientation

string | null

ariaOwnsElements

readonly Element[] | null

ariaPlaceholder

string | null

ariaPosInSet

string | null

ariaPressed

string | null

ariaReadOnly

string | null

ariaRelevant

string | null

ariaRequired

string | null

ariaRoleDescription

string | null

ariaRowCount

string | null

ariaRowIndex

string | null

ariaRowIndexText

string | null

ariaRowSpan

string | null

ariaSelected

string | null

ariaSetSize

string | null

ariaSort

string | null

ariaValueMax

string | null

ariaValueMin

string | null

ariaValueNow

string | null

ariaValueText

string | null

role

string | null

animate

Animation

MDN Reference

@paramkeyframesKeyframe[] | PropertyIndexedKeyframes | null
@paramoptionsnumber | KeyframeAnimationOptions | undefined
@returnsAnimation

getAnimations

Animation[]

MDN Reference

@paramoptionsGetAnimationsOptions | undefined
@returnsAnimation[]

after

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

@paramnodes(string | Node)[]
@returnsvoid

before

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

@paramnodes(string | Node)[]
@returnsvoid

remove

void

Removes node.

MDN Reference

@returnsvoid

replaceWith

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

@paramnodes(string | Node)[]
@returnsvoid

nextElementSibling

Element | null

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

MDN Reference

previousElementSibling

Element | null

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

MDN Reference

childElementCount

number

children

HTMLCollection

Returns the child elements.

MDN Reference

firstElementChild

Element | null

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

MDN Reference

lastElementChild

Element | null

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

MDN Reference

append

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

@paramnodes(string | Node)[]
@returnsvoid

prepend

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

@paramnodes(string | Node)[]
@returnsvoid

querySelector

HTMLElementTagNameMap[K] | null

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

MDN Reference

@paramselectorsK
@returnsHTMLElementTagNameMap[K] | null

querySelector

SVGElementTagNameMap[K] | null
@paramselectorsK
@returnsSVGElementTagNameMap[K] | null

querySelector

MathMLElementTagNameMap[K] | null
@paramselectorsK
@returnsMathMLElementTagNameMap[K] | null

querySelector

HTMLElementDeprecatedTagNameMap[K] | null
@deprecated
@paramselectorsK
@returnsHTMLElementDeprecatedTagNameMap[K] | null

querySelector

E | null
@paramselectorsstring
@returnsE | null

querySelectorAll

NodeListOf<HTMLElementTagNameMap[K]>

Returns all element descendants of node that match selectors.

MDN Reference

@paramselectorsK
@returnsNodeListOf<HTMLElementTagNameMap[K]>

querySelectorAll

NodeListOf<SVGElementTagNameMap[K]>
@paramselectorsK
@returnsNodeListOf<SVGElementTagNameMap[K]>

querySelectorAll

NodeListOf<MathMLElementTagNameMap[K]>
@paramselectorsK
@returnsNodeListOf<MathMLElementTagNameMap[K]>

querySelectorAll

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
@deprecated
@paramselectorsK
@returnsNodeListOf<HTMLElementDeprecatedTagNameMap[K]>

querySelectorAll

NodeListOf<E>
@paramselectorsstring
@returnsNodeListOf<E>

replaceChildren

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

@paramnodes(string | Node)[]
@returnsvoid

assignedSlot

HTMLSlotElement | null

attributeStyleMap

StylePropertyMap

style

CSSStyleDeclaration

style

CSSStyleDeclaration

contentEditable

string

enterKeyHint

string

inputMode

string

isContentEditable

boolean

onabort

((this: GlobalEventHandlers, ev: UIEvent) => any) | null

onanimationcancel

((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationend

((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationiteration

((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onanimationstart

((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null

onauxclick

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onbeforeinput

((this: GlobalEventHandlers, ev: InputEvent) => any) | null

onbeforematch

((this: GlobalEventHandlers, ev: Event) => any) | null

onbeforetoggle

((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null

onblur

((this: GlobalEventHandlers, ev: FocusEvent) => any) | null

oncancel

((this: GlobalEventHandlers, ev: Event) => any) | null

oncanplay

((this: GlobalEventHandlers, ev: Event) => any) | null

oncanplaythrough

((this: GlobalEventHandlers, ev: Event) => any) | null

onchange

((this: GlobalEventHandlers, ev: Event) => any) | null

onclick

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onclose

((this: GlobalEventHandlers, ev: Event) => any) | null

oncontextlost

((this: GlobalEventHandlers, ev: Event) => any) | null

oncontextmenu

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

oncontextrestored

((this: GlobalEventHandlers, ev: Event) => any) | null

oncopy

((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null

oncuechange

((this: GlobalEventHandlers, ev: Event) => any) | null

oncut

((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null

ondblclick

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

ondrag

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondragend

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondragenter

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondragleave

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondragover

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondragstart

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondrop

((this: GlobalEventHandlers, ev: DragEvent) => any) | null

ondurationchange

((this: GlobalEventHandlers, ev: Event) => any) | null

onemptied

((this: GlobalEventHandlers, ev: Event) => any) | null

onended

((this: GlobalEventHandlers, ev: Event) => any) | null

onerror

OnErrorEventHandler

onfocus

((this: GlobalEventHandlers, ev: FocusEvent) => any) | null

onformdata

((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null

ongotpointercapture

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

oninput

((this: GlobalEventHandlers, ev: Event) => any) | null

oninvalid

((this: GlobalEventHandlers, ev: Event) => any) | null

onkeydown

((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null

onkeypress

((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null
@deprecated

MDN Reference

onkeyup

((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null

onload

((this: GlobalEventHandlers, ev: Event) => any) | null

onloadeddata

((this: GlobalEventHandlers, ev: Event) => any) | null

onloadedmetadata

((this: GlobalEventHandlers, ev: Event) => any) | null

onloadstart

((this: GlobalEventHandlers, ev: Event) => any) | null

onlostpointercapture

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onmousedown

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmouseenter

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmouseleave

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmousemove

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmouseout

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmouseover

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onmouseup

((this: GlobalEventHandlers, ev: MouseEvent) => any) | null

onpaste

((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null

onpause

((this: GlobalEventHandlers, ev: Event) => any) | null

onplay

((this: GlobalEventHandlers, ev: Event) => any) | null

onplaying

((this: GlobalEventHandlers, ev: Event) => any) | null

onpointercancel

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerdown

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerenter

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerleave

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointermove

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerout

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerover

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onpointerrawupdate

((this: GlobalEventHandlers, ev: Event) => any) | null

Available only in secure contexts.

MDN Reference

onpointerup

((this: GlobalEventHandlers, ev: PointerEvent) => any) | null

onprogress

((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any) | null

onratechange

((this: GlobalEventHandlers, ev: Event) => any) | null

onreset

((this: GlobalEventHandlers, ev: Event) => any) | null

onresize

((this: GlobalEventHandlers, ev: UIEvent) => any) | null

onscroll

((this: GlobalEventHandlers, ev: Event) => any) | null

onscrollend

((this: GlobalEventHandlers, ev: Event) => any) | null

onsecuritypolicyviolation

((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null

onseeked

((this: GlobalEventHandlers, ev: Event) => any) | null

onseeking

((this: GlobalEventHandlers, ev: Event) => any) | null

onselect

((this: GlobalEventHandlers, ev: Event) => any) | null

onselectionchange

((this: GlobalEventHandlers, ev: Event) => any) | null

onselectstart

((this: GlobalEventHandlers, ev: Event) => any) | null

onslotchange

((this: GlobalEventHandlers, ev: Event) => any) | null

onstalled

((this: GlobalEventHandlers, ev: Event) => any) | null

onsubmit

((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null

onsuspend

((this: GlobalEventHandlers, ev: Event) => any) | null

ontimeupdate

((this: GlobalEventHandlers, ev: Event) => any) | null

ontoggle

((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null

ontouchcancel

((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined

ontouchend

((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined

ontouchmove

((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined

ontouchstart

((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined

ontransitioncancel

((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionend

((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionrun

((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

ontransitionstart

((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null

onvolumechange

((this: GlobalEventHandlers, ev: Event) => any) | null

onwaiting

((this: GlobalEventHandlers, ev: Event) => any) | null

onwebkitanimationend

((this: GlobalEventHandlers, ev: Event) => any) | null
@deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

((this: GlobalEventHandlers, ev: Event) => any) | null
@deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

((this: GlobalEventHandlers, ev: Event) => any) | null
@deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

((this: GlobalEventHandlers, ev: Event) => any) | null
@deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

((this: GlobalEventHandlers, ev: WheelEvent) => any) | null

autofocus

boolean

dataset

DOMStringMap

nonce

string | undefined

tabIndex

number

blur

void

MDN Reference

@returnsvoid

focus

void

MDN Reference

@paramoptionsFocusOptions | undefined
@returnsvoid
Jump to details