Allows for manipulation of element's class content attribute as a
set of whitespace-separated tokens through a DOMTokenList object.
className
className:string
Returns the value of element's class content attribute. Can be set
to change it.
clientHeight
clientHeight:number
clientLeft
clientLeft:number
clientTop
clientTop:number
clientWidth
clientWidth:number
contentEditable
contentEditable:string
dataset
dataset:DOMStringMap
dir
dir:string
draggable
draggable:boolean
firstChild
firstChild:ChildNode | null
Returns the first child.
firstElementChild
firstElementChild:Element | null
Returns the first child that is an element, and null otherwise.
hidden
hidden:boolean
Protected htmlElement
htmlElement:HTMLDivElement | null
id
id:string
Returns the value of element's id content attribute. Can be set to
change it.
innerHTML
innerHTML:string
innerText
innerText:string
Protected inputContainer
inputContainer:HTMLElement
inputMode
inputMode:string
isConnected
isConnected:boolean
Returns true if node is connected and false otherwise.
isContentEditable
isContentEditable:boolean
lang
lang:string
lastChild
lastChild:ChildNode | null
Returns the last child.
lastElementChild
lastElementChild:Element | null
Returns the last child that is an element, and null otherwise.
localName
localName:string
Returns the local name.
namespaceURI
namespaceURI:string | null
Returns the namespace.
nextElementSibling
nextElementSibling:Element | null
Returns the first following sibling that
is an element, and null otherwise.
nextSibling
nextSibling:ChildNode | null
Returns the next sibling.
nodeName
nodeName:string
Returns a string appropriate for the type of node, as
follows:
Element
Its HTML-uppercased qualified name.
Attr
Its qualified name.
Text
"#text".
CDATASection
"#cdata-section".
ProcessingInstruction
Its target.
Comment
"#comment".
Document
"#document".
DocumentType
Its name.
DocumentFragment
"#document-fragment".
nodeType
nodeType:number
nodeValue
nodeValue:string | null
Optional nonce
nonce:undefined | string
offsetHeight
offsetHeight:number
offsetLeft
offsetLeft:number
offsetParent
offsetParent:Element | null
offsetTop
offsetTop:number
offsetWidth
offsetWidth:number
onabort
onabort:function | null
Fires when the user aborts the download.
param
The event.
onanimationcancel
onanimationcancel:function | null
onanimationend
onanimationend:function | null
onanimationiteration
onanimationiteration:function | null
onanimationstart
onanimationstart:function | null
onauxclick
onauxclick:function | null
onblur
onblur:function | null
Fires when the object loses the input focus.
param
The focus event.
oncancel
oncancel:function | null
oncanplay
oncanplay:function | null
Occurs when playback is possible, but would require further buffering.
param
The event.
oncanplaythrough
oncanplaythrough:function | null
onchange
onchange:function | null
Fires when the contents of the object or selection have changed.
param
The event.
onclick
onclick:function | null
Fires when the user clicks the left mouse button on the object
param
The mouse event.
onclose
onclose:function | null
oncontextmenu
oncontextmenu:function | null
Fires when the user clicks the right mouse button in the client area, opening the context menu.
param
The mouse event.
oncopy
oncopy:function | null
oncuechange
oncuechange:function | null
oncut
oncut:function | null
ondblclick
ondblclick:function | null
Fires when the user double-clicks the object.
param
The mouse event.
ondrag
ondrag:function | null
Fires on the source object continuously during a drag operation.
param
The event.
ondragend
ondragend:function | null
Fires on the source object when the user releases the mouse at the close of a drag operation.
param
The event.
ondragenter
ondragenter:function | null
Fires on the target element when the user drags the object to a valid drop target.
param
The drag event.
ondragexit
ondragexit:function | null
ondragleave
ondragleave:function | null
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
param
The drag event.
ondragover
ondragover:function | null
Fires on the target element continuously while the user drags the object over a valid drop target.
param
The event.
ondragstart
ondragstart:function | null
Fires on the source object when the user starts to drag a text selection or selected object.
param
The event.
ondrop
ondrop:function | null
ondurationchange
ondurationchange:function | null
Occurs when the duration attribute is updated.
param
The event.
onemptied
onemptied:function | null
Occurs when the media element is reset to its initial state.
param
The event.
onended
onended:function | null
Occurs when the end of playback is reached.
param
The event
onerror
onerror:OnErrorEventHandler
Fires when an error occurs during object loading.
param
The event.
onfocus
onfocus:function | null
Fires when the object receives focus.
param
The event.
onfullscreenchange
onfullscreenchange:function | null
onfullscreenerror
onfullscreenerror:function | null
ongotpointercapture
ongotpointercapture:function | null
oninput
oninput:function | null
oninvalid
oninvalid:function | null
onkeydown
onkeydown:function | null
Fires when the user presses a key.
param
The keyboard event
onkeypress
onkeypress:function | null
Fires when the user presses an alphanumeric key.
param
The event.
onkeyup
onkeyup:function | null
Fires when the user releases a key.
param
The keyboard event
onload
onload:function | null
Fires immediately after the browser loads the object.
param
The event.
onloadeddata
onloadeddata:function | null
Occurs when media data is loaded at the current playback position.
param
The event.
onloadedmetadata
onloadedmetadata:function | null
Occurs when the duration and dimensions of the media have been determined.
param
The event.
onloadend
onloadend:function | null
onloadstart
onloadstart:function | null
Occurs when Internet Explorer begins looking for media data.
param
The event.
onlostpointercapture
onlostpointercapture:function | null
onmousedown
onmousedown:function | null
Fires when the user clicks the object with either mouse button.
param
The mouse event.
onmouseenter
onmouseenter:function | null
onmouseleave
onmouseleave:function | null
onmousemove
onmousemove:function | null
Fires when the user moves the mouse over the object.
param
The mouse event.
onmouseout
onmouseout:function | null
Fires when the user moves the mouse pointer outside the boundaries of the object.
param
The mouse event.
onmouseover
onmouseover:function | null
Fires when the user moves the mouse pointer into the object.
param
The mouse event.
onmouseup
onmouseup:function | null
Fires when the user releases a mouse button while the mouse is over the object.
param
The mouse event.
onpaste
onpaste:function | null
onpause
onpause:function | null
Occurs when playback is paused.
param
The event.
onplay
onplay:function | null
Occurs when the play method is requested.
param
The event.
onplaying
onplaying:function | null
Occurs when the audio or video has started playing.
param
The event.
onpointercancel
onpointercancel:function | null
onpointerdown
onpointerdown:function | null
onpointerenter
onpointerenter:function | null
onpointerleave
onpointerleave:function | null
onpointermove
onpointermove:function | null
onpointerout
onpointerout:function | null
onpointerover
onpointerover:function | null
onpointerup
onpointerup:function | null
onprogress
onprogress:function | null
Occurs to indicate progress while downloading media data.
param
The event.
onratechange
onratechange:function | null
Occurs when the playback rate is increased or decreased.
param
The event.
onreset
onreset:function | null
Fires when the user resets a form.
param
The event.
onresize
onresize:function | null
onscroll
onscroll:function | null
Fires when the user repositions the scroll box in the scroll bar on the object.
param
The event.
onsecuritypolicyviolation
onsecuritypolicyviolation:function | null
onseeked
onseeked:function | null
Occurs when the seek operation ends.
param
The event.
onseeking
onseeking:function | null
Occurs when the current playback position is moved.
param
The event.
onselect
onselect:function | null
Fires when the current selection changes.
param
The event.
onselectionchange
onselectionchange:function | null
onselectstart
onselectstart:function | null
onstalled
onstalled:function | null
Occurs when the download has stopped.
param
The event.
onsubmit
onsubmit:function | null
onsuspend
onsuspend:function | null
Occurs if the load operation has been intentionally halted.
param
The event.
ontimeupdate
ontimeupdate:function | null
Occurs to indicate the current playback position.
param
The event.
ontoggle
ontoggle:function | null
ontouchcancel
ontouchcancel:function | null
ontouchend
ontouchend:function | null
ontouchmove
ontouchmove:function | null
ontouchstart
ontouchstart:function | null
ontransitioncancel
ontransitioncancel:function | null
ontransitionend
ontransitionend:function | null
ontransitionrun
ontransitionrun:function | null
ontransitionstart
ontransitionstart:function | null
onvolumechange
onvolumechange:function | null
Occurs when the volume is changed, or playback is muted or unmuted.
param
The event.
onwaiting
onwaiting:function | null
Occurs when playback stops because the next frame of a video resource is not available.
param
The event.
onwheel
onwheel:function | null
outerHTML
outerHTML:string
ownerDocument
ownerDocument:Document | null
Returns the node document.
Returns null for documents.
parentElement
parentElement:HTMLElement | null
Returns the parent element.
parentNode
parentNode:Node & ParentNode | null
Returns the parent.
prefix
prefix:string | null
Returns the namespace prefix.
previousElementSibling
previousElementSibling:Element | null
Returns the first preceding sibling that
is an element, and null otherwise.
previousSibling
previousSibling:Node | null
Returns the previous sibling.
scrollHeight
scrollHeight:number
scrollLeft
scrollLeft:number
scrollTop
scrollTop:number
scrollWidth
scrollWidth:number
shadowDOM
shadowDOM:ShadowRoot
shadowRoot
shadowRoot:ShadowRoot | null
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
slot
slot:string
Returns the value of element's slot content attribute. Can be set to
change it.
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.
Optional options: number | KeyframeAnimationOptions
Returns Animation
append
append(...nodes: (string | Node)[]): void
Inserts nodes after the last child of node, while replacing
strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of
the node tree are violated.
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.
Parameters
Rest...nodes: (string | Node)[]
Returns void
blur
blur(): void
Returns void
click
click(): void
Returns void
cloneNode
cloneNode(deep?: undefined | false | true): Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Type parameters
K: keyof HTMLElementTagNameMap
Parameters
selector: K
Returns HTMLElementTagNameMap[K] | null
Type parameters
K: keyof SVGElementTagNameMap
Parameters
selector: K
Returns SVGElementTagNameMap[K] | null
Parameters
selector: string
Returns Element | null
compareDocumentPosition
compareDocumentPosition(other: Node): number
Parameters
other: Node
Returns number
connectedCallback
connectedCallback(): void
Returns void
contains
contains(other: Node | null): boolean
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
other: Node | null
Returns boolean
disconnectedCallback
disconnectedCallback(): void
Returns void
dispatchEvent
dispatchEvent(event: Event): boolean
Dispatches a synthetic event event to target and returns true
if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
event: Event
Returns boolean
flatChildren
flatChildren<T>(type?: undefined | object): T[]
All descendents recursively. Optionally filtered by type.
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
selectors: string
Returns boolean
msGetRegionContent
msGetRegionContent(): any
Returns any
normalize
normalize(): void
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns void
Protected onValueChange
onValueChange(): void
Returns void
prepend
prepend(...nodes: (string | Node)[]): void
Inserts nodes before the first child of node, while
replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of
the node tree are violated.
(this: HTMLElement, ev: HTMLElementEventMap[K]): any
Parameters
this: HTMLElement
ev: HTMLElementEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
removeShadowChildren
removeShadowChildren(): void
Remove every child element from shadow dom
Returns void
render
render(attributes: object): void
Updates state and renders the shadow dom. By default adds the string returned by template to the innerHTML
of a div in the shadow dom and the css to a style element in the shadow dom.
Parameters
attributes: object
The current attributes and their values defined on the html element.
[name: string]: string | null
Returns void
replaceChild
replaceChild<T>(newChild: Node, oldChild: T): T
Type parameters
T: Node
Parameters
newChild: Node
oldChild: T
Returns T
replaceWith
replaceWith(...nodes: (string | Node)[]): 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.
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.
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.
Parameters
qualifiedName: string
Optional force: undefined | false | true
Returns boolean
Abstract updateFromAttributes
updateFromAttributes(attributes: object): void
Updates the state of this element and any DOM updates. Called when any updates are made to the
observed attributes of this element. All important state should be stored via the attributes,
so all updates should be made here.