• 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

accessKeyLabel

string

autocapitalize

string

dir

string

draggable

boolean

hidden

boolean

inert

boolean

innerText

string

lang

string

offsetHeight

number

offsetLeft

number

offsetParent

Element | null

offsetTop

number

offsetWidth

number

outerText

string

popover

string | null

spellcheck

boolean

title

string

translate

boolean

writingSuggestions

string

attachInternals

ElementInternals

MDN Reference

@returnsElementInternals

click

void

MDN Reference

@returnsvoid

hidePopover

void

MDN Reference

@returnsvoid

showPopover

void

MDN Reference

@returnsvoid

togglePopover

boolean

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

classList

DOMTokenList

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

MDN Reference

classList

DOMTokenList

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

currentCSSZoom

number

id

string

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

MDN Reference

innerHTML

string

localName

string

Returns the local name.

MDN Reference

namespaceURI

string | null

Returns the namespace.

MDN Reference

onfullscreenchange

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

onfullscreenerror

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

outerHTML

string

ownerDocument

Document

part

DOMTokenList

part

DOMTokenList

prefix

string | null

Returns the namespace prefix.

MDN Reference

scrollHeight

number

scrollLeft

number

scrollTop

number

scrollWidth

number

shadowRoot

ShadowRoot | null

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

attachShadow

ShadowRoot

Creates a shadow root for element and returns it.

MDN Reference

@paraminitShadowRootInit
@returnsShadowRoot

checkVisibility

boolean

MDN Reference

@paramoptionsCheckVisibilityOptions | undefined
@returnsboolean

closest

HTMLElementTagNameMap[K] | null

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

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

MDN Reference

@returnsStylePropertyMapReadOnly

getAttribute

string | null

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

MDN Reference

@paramqualifiedNamestring
@returnsstring | null

getAttributeNS

string | null

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

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsstring | null

getAttributeNames

string[]

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

MDN Reference

@returnsstring[]

getAttributeNode

Attr | null

MDN Reference

@paramqualifiedNamestring
@returnsAttr | null

getAttributeNodeNS

Attr | null

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsAttr | null

getBoundingClientRect

DOMRect

MDN Reference

@returnsDOMRect

getClientRects

DOMRectList

MDN Reference

@returnsDOMRectList

getElementsByClassName

HTMLCollectionOf<Element>

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

@paramclassNamesstring
@returnsHTMLCollectionOf<Element>

getElementsByTagName

HTMLCollectionOf<HTMLElementTagNameMap[K]>

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>

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

MDN Reference

@paramoptionsGetHTMLOptions | undefined
@returnsstring

hasAttribute

boolean

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

MDN Reference

@paramqualifiedNamestring
@returnsboolean

hasAttributeNS

boolean

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

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsboolean

hasAttributes

boolean

Returns true if element has attributes, and false otherwise.

MDN Reference

@returnsboolean

hasPointerCapture

boolean

MDN Reference

@parampointerIdnumber
@returnsboolean

insertAdjacentElement

Element | null

MDN Reference

@paramwhereInsertPosition
@paramelementElement
@returnsElement | null

insertAdjacentHTML

void

MDN Reference

@parampositionInsertPosition
@paramstringstring
@returnsvoid

insertAdjacentText

void

MDN Reference

@paramwhereInsertPosition
@paramdatastring
@returnsvoid

matches

boolean

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

MDN Reference

@paramselectorsstring
@returnsboolean

releasePointerCapture

void

MDN Reference

@parampointerIdnumber
@returnsvoid

removeAttribute

void

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

MDN Reference

@paramqualifiedNamestring
@returnsvoid

removeAttributeNS

void

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

MDN Reference

@paramnamespacestring | null
@paramlocalNamestring
@returnsvoid

removeAttributeNode

Attr

MDN Reference

@paramattrAttr
@returnsAttr

requestFullscreen

Promise<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

@paramoptionsFullscreenOptions | undefined
@returnsPromise<void>

requestPointerLock

Promise<void>

MDN Reference

@paramoptionsPointerLockOptions | undefined
@returnsPromise<void>

scroll

void

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scroll

void
@paramxnumber
@paramynumber
@returnsvoid

scrollBy

void

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scrollBy

void
@paramxnumber
@paramynumber
@returnsvoid

scrollIntoView

void

MDN Reference

@paramargboolean | ScrollIntoViewOptions | undefined
@returnsvoid

scrollTo

void

MDN Reference

@paramoptionsScrollToOptions | undefined
@returnsvoid

scrollTo

void
@paramxnumber
@paramynumber
@returnsvoid

setAttribute

void

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

MDN Reference

@paramqualifiedNamestring
@paramvaluestring
@returnsvoid

setAttributeNS

void

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

MDN Reference

@paramnamespacestring | null
@paramqualifiedNamestring
@paramvaluestring
@returnsvoid

setAttributeNode

Attr | null

MDN Reference

@paramattrAttr
@returnsAttr | null

setAttributeNodeNS

Attr | null

MDN Reference

@paramattrAttr
@returnsAttr | null

setHTMLUnsafe

void

MDN Reference

@paramhtmlstring
@returnsvoid

setPointerCapture

void

MDN Reference

@parampointerIdnumber
@returnsvoid

toggleAttribute

boolean

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

@paramqualifiedNamestring
@paramforceboolean | undefined
@returnsboolean

webkitMatchesSelector

boolean
@deprecated

This is a legacy alias of matches.

MDN Reference

@paramselectorsstring
@returnsboolean

baseURI

string

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

MDN Reference

childNodes

NodeListOf<ChildNode>

Returns the children.

MDN Reference

firstChild

ChildNode | null

Returns the first child.

MDN Reference

isConnected

boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild

ChildNode | null

Returns the last child.

MDN Reference

nextSibling

ChildNode | null

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

string | null

parentElement

HTMLElement | null

Returns the parent element.

MDN Reference

parentNode

ParentNode | null

Returns the parent.

MDN Reference

previousSibling

ChildNode | null

Returns the previous sibling.

MDN Reference

textContent

string | null

appendChild

T

MDN Reference

@paramnodeT
@returnsT

cloneNode

Node

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

MDN Reference

@paramsubtreeboolean | undefined
@returnsNode

compareDocumentPosition

number

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

MDN Reference

@paramotherNode
@returnsnumber

contains

boolean

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

MDN Reference

@paramotherNode | null
@returnsboolean

getRootNode

Node

Returns node's root.

MDN Reference

@paramoptionsGetRootNodeOptions | undefined
@returnsNode

hasChildNodes

boolean

Returns whether node has children.

MDN Reference

@returnsboolean

insertBefore

T

MDN Reference

@paramnodeT
@paramchildNode | null
@returnsT

isDefaultNamespace

boolean

MDN Reference

@paramnamespacestring | null
@returnsboolean

isEqualNode

boolean

Returns whether node and otherNode have the same properties.

MDN Reference

@paramotherNodeNode | null
@returnsboolean

isSameNode

boolean

MDN Reference

@paramotherNodeNode | null
@returnsboolean

lookupNamespaceURI

string | null

MDN Reference

@paramprefixstring | null
@returnsstring | null

lookupPrefix

string | null

MDN Reference

@paramnamespacestring | null
@returnsstring | null

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

@returnsvoid

removeChild

T

MDN Reference

@paramchildT
@returnsT

replaceChild

T

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

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

@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[]

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

ariaCurrent

string | null

ariaDescription

string | null

ariaDisabled

string | null

ariaExpanded

string | null

ariaHasPopup

string | null

ariaHidden

string | null

ariaInvalid

string | null

ariaKeyShortcuts

string | null

ariaLabel

string | null

ariaLevel

string | null

ariaLive

string | null

ariaModal

string | null

ariaMultiLine

string | null

ariaMultiSelectable

string | null

ariaOrientation

string | 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

Fires when the user aborts the download.

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: MouseEvent) => any) | null

onbeforeinput

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

onbeforetoggle

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

onblur

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

Fires when the object loses the input focus.

oncancel

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

oncanplay

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

Occurs when playback is possible, but would require further buffering.

oncanplaythrough

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

onchange

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

Fires when the contents of the object or selection have changed.

onclick

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

Fires when the user clicks the left mouse button on the object

onclose

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

oncontextlost

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

oncontextmenu

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

Fires when the user clicks the right mouse button in the client area, opening the context menu.

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

Fires when the user double-clicks the object.

ondrag

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

Fires on the source object continuously during a drag operation.

ondragend

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

Fires on the source object when the user releases the mouse at the close of a drag operation.

ondragenter

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

Fires on the target element when the user drags the object to a valid drop target.

ondragleave

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

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

ondragover

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

Fires on the target element continuously while the user drags the object over a valid drop target.

ondragstart

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

Fires on the source object when the user starts to drag a text selection or selected object.

ondrop

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

ondurationchange

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

Occurs when the duration attribute is updated.

onemptied

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

Occurs when the media element is reset to its initial state.

onended

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

Occurs when the end of playback is reached.

onerror

OnErrorEventHandler

Fires when an error occurs during object loading.

onfocus

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

Fires when the object receives focus.

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

Fires when the user presses a key.

onkeypress

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

MDN Reference

Fires when the user presses an alphanumeric key.

onkeyup

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

Fires when the user releases a key.

onload

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

Fires immediately after the browser loads the object.

onloadeddata

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

Occurs when media data is loaded at the current playback position.

onloadedmetadata

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

Occurs when the duration and dimensions of the media have been determined.

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

onlostpointercapture

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

onmousedown

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

Fires when the user clicks the object with either mouse button.

onmouseenter

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

onmouseleave

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

onmousemove

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

Fires when the user moves the mouse over the object.

onmouseout

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

Fires when the user moves the mouse pointer outside the boundaries of the object.

onmouseover

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

Fires when the user moves the mouse pointer into the object.

onmouseup

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

Fires when the user releases a mouse button while the mouse is over the object.

onpaste

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

onpause

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

Occurs when playback is paused.

onplay

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

Occurs when the play method is requested.

onplaying

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

Occurs when the audio or video has started playing.

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

onpointerup

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

onprogress

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

Occurs to indicate progress while downloading media data.

onratechange

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

Occurs when the playback rate is increased or decreased.

onreset

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

Fires when the user resets a form.

onresize

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

onscroll

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

Fires when the user repositions the scroll box in the scroll bar on the object.

onscrollend

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

onsecuritypolicyviolation

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

onseeked

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

Occurs when the seek operation ends.

onseeking

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

Occurs when the current playback position is moved.

onselect

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

Fires when the current selection changes.

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

Occurs when the download has stopped.

onsubmit

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

onsuspend

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

Occurs if the load operation has been intentionally halted.

ontimeupdate

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

Occurs to indicate the current playback position.

ontoggle

((this: GlobalEventHandlers, ev: Event) => 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

Occurs when the volume is changed, or playback is muted or unmuted.

onwaiting

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

Occurs when playback stops because the next frame of a video resource is not available.

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