Skip to content

Interface: SignalWatcher

Defined in: @lit-labs/signals:

See

https://lit.dev/docs/data/signals/

Extends

  • ReactiveElement

Other

_watcher?

ts
optional _watcher?: Watcher;

Defined in: @lit-labs/signals:


accessKey

ts
accessKey: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.accessKey

accessKeyLabel

ts
readonly accessKeyLabel: string;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.accessKeyLabel

ariaActiveDescendantElement

ts
ariaActiveDescendantElement: Element | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaActiveDescendantElement

ariaAtomic

ts
ariaAtomic: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaAtomic

ariaAutoComplete

ts
ariaAutoComplete: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaAutoComplete

ariaBrailleLabel

ts
ariaBrailleLabel: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaBrailleLabel

ariaBrailleRoleDescription

ts
ariaBrailleRoleDescription: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaBrailleRoleDescription

ariaBusy

ts
ariaBusy: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaBusy

ariaChecked

ts
ariaChecked: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaChecked

ariaColCount

ts
ariaColCount: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaColCount

ariaColIndex

ts
ariaColIndex: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaColIndex

ariaColIndexText

ts
ariaColIndexText: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaColIndexText

ariaColSpan

ts
ariaColSpan: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaColSpan

ariaControlsElements

ts
ariaControlsElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaControlsElements

ariaCurrent

ts
ariaCurrent: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaCurrent

ariaDescribedByElements

ts
ariaDescribedByElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaDescribedByElements

ariaDescription

ts
ariaDescription: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaDescription

ariaDetailsElements

ts
ariaDetailsElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaDetailsElements

ariaDisabled

ts
ariaDisabled: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaDisabled

ariaErrorMessageElements

ts
ariaErrorMessageElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaErrorMessageElements

ariaExpanded

ts
ariaExpanded: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaExpanded

ariaFlowToElements

ts
ariaFlowToElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaFlowToElements

ariaHasPopup

ts
ariaHasPopup: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaHasPopup

ariaHidden

ts
ariaHidden: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaHidden

ariaInvalid

ts
ariaInvalid: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaInvalid

ariaKeyShortcuts

ts
ariaKeyShortcuts: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaKeyShortcuts

ariaLabel

ts
ariaLabel: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaLabel

ariaLabelledByElements

ts
ariaLabelledByElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaLabelledByElements

ariaLevel

ts
ariaLevel: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaLevel

ariaLive

ts
ariaLive: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaLive

ariaModal

ts
ariaModal: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaModal

ariaMultiLine

ts
ariaMultiLine: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaMultiLine

ariaMultiSelectable

ts
ariaMultiSelectable: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaMultiSelectable

ariaOrientation

ts
ariaOrientation: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaOrientation

ariaOwnsElements

ts
ariaOwnsElements: readonly Element[] | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaOwnsElements

ariaPlaceholder

ts
ariaPlaceholder: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaPlaceholder

ariaPosInSet

ts
ariaPosInSet: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaPosInSet

ariaPressed

ts
ariaPressed: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaPressed

ariaReadOnly

ts
ariaReadOnly: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaReadOnly

ariaRelevant

ts
ariaRelevant: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRelevant

ariaRequired

ts
ariaRequired: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRequired

ariaRoleDescription

ts
ariaRoleDescription: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRoleDescription

ariaRowCount

ts
ariaRowCount: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRowCount

ariaRowIndex

ts
ariaRowIndex: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRowIndex

ariaRowIndexText

ts
ariaRowIndexText: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRowIndexText

ariaRowSpan

ts
ariaRowSpan: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaRowSpan

ariaSelected

ts
ariaSelected: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaSelected

ariaSetSize

ts
ariaSetSize: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaSetSize

ariaSort

ts
ariaSort: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaSort

ariaValueMax

ts
ariaValueMax: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaValueMax

ariaValueMin

ts
ariaValueMin: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaValueMin

ariaValueNow

ts
ariaValueNow: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaValueNow

ariaValueText

ts
ariaValueText: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ariaValueText

assignedSlot

ts
readonly assignedSlot: HTMLSlotElement | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.assignedSlot

ATTRIBUTE_NODE

ts
readonly ATTRIBUTE_NODE: 2;

Defined in: typescript:

Inherited from

ts
ReactiveElement.ATTRIBUTE_NODE

attributes

ts
readonly attributes: NamedNodeMap;

Defined in: typescript:

The Element.attributes property returns a live collection of all attribute nodes registered to the specified node. It is a NamedNodeMap, not an Array, so it has no Array methods and the Attr nodes' indexes may differ among browsers. To be more specific, attributes is a key/value pair of strings that represents any information regarding that attribute.

MDN Reference

Inherited from

ts
ReactiveElement.attributes

attributeStyleMap

ts
readonly attributeStyleMap: StylePropertyMap;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.attributeStyleMap

autocapitalize

ts
autocapitalize: string;

Defined in: typescript:

The autocapitalize property of the HTMLElement interface represents the element's capitalization behavior for user input. It is available on all HTML elements, though it doesn't affect all of them, including:

MDN Reference

Inherited from

ts
ReactiveElement.autocapitalize

autocorrect

ts
autocorrect: boolean;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.autocorrect

autofocus

ts
autofocus: boolean;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.autofocus

baseURI

ts
readonly baseURI: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.baseURI

CDATA_SECTION_NODE

ts
readonly CDATA_SECTION_NODE: 4;

Defined in: typescript:

node is a CDATASection node.

Inherited from

ts
ReactiveElement.CDATA_SECTION_NODE

childElementCount

ts
readonly childElementCount: number;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.childElementCount

childNodes

ts
readonly childNodes: NodeListOf<ChildNode>;

Defined in: typescript:

The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.

MDN Reference

Inherited from

ts
ReactiveElement.childNodes

children

ts
readonly children: HTMLCollection;

Defined in: typescript:

Returns the child elements.

MDN Reference

Inherited from

ts
ReactiveElement.children

className

ts
className: string;

Defined in: typescript:

The className property of the Element interface gets and sets the value of the class attribute of the specified element.

MDN Reference

Inherited from

ts
ReactiveElement.className

clientHeight

ts
readonly clientHeight: number;

Defined in: typescript:

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. It includes padding but excludes borders, margins, and horizontal scrollbars (if present).

MDN Reference

Inherited from

ts
ReactiveElement.clientHeight

clientLeft

ts
readonly clientLeft: number;

Defined in: typescript:

The clientLeft read-only property of the Element interface returns the width of the left border of an element in pixels. It includes the width of the vertical scrollbar if the text direction of the element is right-to-left and if there is an overflow causing a left vertical scrollbar to be rendered. clientLeft does not include the left margin or the left padding.

MDN Reference

Inherited from

ts
ReactiveElement.clientLeft

clientTop

ts
readonly clientTop: number;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.clientTop

clientWidth

ts
readonly clientWidth: number;

Defined in: typescript:

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. It includes padding but excludes borders, margins, and vertical scrollbars (if present).

MDN Reference

Inherited from

ts
ReactiveElement.clientWidth

COMMENT_NODE

ts
readonly COMMENT_NODE: 8;

Defined in: typescript:

node is a Comment node.

Inherited from

ts
ReactiveElement.COMMENT_NODE

contentEditable

ts
contentEditable: string;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.contentEditable

currentCSSZoom

ts
readonly currentCSSZoom: number;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.currentCSSZoom

customElementRegistry

ts
readonly customElementRegistry: CustomElementRegistry | null;

Defined in: typescript:

Inherited from

SignalWatcher.customElementRegistry


dataset

ts
readonly dataset: DOMStringMap;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.dataset

dir

ts
dir: string;

Defined in: typescript:

The HTMLElement.dir property indicates the text writing directionality of the content of the current element. It reflects the element's dir attribute.

MDN Reference

Inherited from

ts
ReactiveElement.dir

DOCUMENT_FRAGMENT_NODE

ts
readonly DOCUMENT_FRAGMENT_NODE: 11;

Defined in: typescript:

node is a DocumentFragment node.

Inherited from

ts
ReactiveElement.DOCUMENT_FRAGMENT_NODE

DOCUMENT_NODE

ts
readonly DOCUMENT_NODE: 9;

Defined in: typescript:

node is a document.

Inherited from

ts
ReactiveElement.DOCUMENT_NODE

DOCUMENT_POSITION_CONTAINED_BY

ts
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;

Defined in: typescript:

Set when other is a descendant of node.

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINS

ts
readonly DOCUMENT_POSITION_CONTAINS: 8;

Defined in: typescript:

Set when other is an ancestor of node.

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_DISCONNECTED

ts
readonly DOCUMENT_POSITION_DISCONNECTED: 1;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_FOLLOWING

ts
readonly DOCUMENT_POSITION_FOLLOWING: 4;

Defined in: typescript:

Set when other is following node.

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

ts
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;

Defined in: typescript:

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_PRECEDING

ts
readonly DOCUMENT_POSITION_PRECEDING: 2;

Defined in: typescript:

Set when other is preceding node.

Inherited from

ts
ReactiveElement.DOCUMENT_POSITION_PRECEDING

DOCUMENT_TYPE_NODE

ts
readonly DOCUMENT_TYPE_NODE: 10;

Defined in: typescript:

node is a doctype.

Inherited from

ts
ReactiveElement.DOCUMENT_TYPE_NODE

draggable

ts
draggable: boolean;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.draggable

ELEMENT_NODE

ts
readonly ELEMENT_NODE: 1;

Defined in: typescript:

node is an element.

Inherited from

ts
ReactiveElement.ELEMENT_NODE

enterKeyHint

ts
enterKeyHint: string;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.enterKeyHint

ENTITY_NODE

ts
readonly ENTITY_NODE: 6;

Defined in: typescript:

Inherited from

ts
ReactiveElement.ENTITY_NODE

ENTITY_REFERENCE_NODE

ts
readonly ENTITY_REFERENCE_NODE: 5;

Defined in: typescript:

Inherited from

ts
ReactiveElement.ENTITY_REFERENCE_NODE

firstChild

ts
readonly firstChild: ChildNode | null;

Defined in: typescript:

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

Inherited from

SignalWatcher.firstChild


firstElementChild

ts
readonly firstElementChild: Element | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.firstElementChild


hidden

ts
hidden: boolean | "until-found";

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.hidden


id

ts
id: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.id

inert

ts
inert: boolean;

Defined in: typescript:

The HTMLElement property inert reflects the value of the element's inert attribute. It is a boolean value that, when present, makes the browser "ignore" user input events for the element, including focus events and events from assistive technologies. The browser may also ignore page search and text selection in the element. This can be useful when building UIs such as modals where you would want to "trap" the focus inside the modal when it's visible.

MDN Reference

Inherited from

ts
ReactiveElement.inert

innerHTML

ts
innerHTML: string;

Defined in: typescript:

The innerHTML property of the Element interface gets or sets the HTML or XML markup contained within the element, omitting any shadow roots in both cases.

MDN Reference

Inherited from

ts
ReactiveElement.innerHTML

innerText

ts
innerText: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.innerText

inputMode

ts
inputMode: string;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.inputMode

isConnected

ts
readonly isConnected: boolean;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.isConnected

isContentEditable

ts
readonly isContentEditable: boolean;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.isContentEditable

lang

ts
lang: string;

Defined in: typescript:

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 BCP 47 language tag. It reflects the element's lang attribute; the xml:lang attribute does not affect this property.

MDN Reference

Inherited from

ts
ReactiveElement.lang

lastChild

ts
readonly lastChild: ChildNode | null;

Defined in: typescript:

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

Inherited from

SignalWatcher.lastChild


lastElementChild

ts
readonly lastElementChild: Element | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.lastElementChild


localName

ts
readonly localName: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.localName

namespaceURI

ts
readonly namespaceURI: string | null;

Defined in: typescript:

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

Inherited from

SignalWatcher.namespaceURI


nextElementSibling

ts
readonly nextElementSibling: Element | null;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.nextElementSibling

nextSibling

ts
readonly nextSibling: ChildNode | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.nextSibling


nodeName

ts
readonly nodeName: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.nodeName

nodeType

ts
readonly nodeType: number;

Defined in: typescript:

The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kinds of nodes from each other, such as elements, text, and comments.

MDN Reference

Inherited from

ts
ReactiveElement.nodeType

nodeValue

ts
nodeValue: string | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.nodeValue


nonce

ts
nonce: string;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.nonce

NOTATION_NODE

ts
readonly NOTATION_NODE: 12;

Defined in: typescript:

Inherited from

ts
ReactiveElement.NOTATION_NODE

offsetHeight

ts
readonly offsetHeight: number;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.offsetHeight

offsetLeft

ts
readonly offsetLeft: number;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.offsetLeft

offsetParent

ts
readonly offsetParent: Element | null;

Defined in: typescript:

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

Inherited from

SignalWatcher.offsetParent


offsetTop

ts
readonly offsetTop: number;

Defined in: typescript:

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 offsetParent, the closest positioned ancestor element.

MDN Reference

Inherited from

ts
ReactiveElement.offsetTop

offsetWidth

ts
readonly offsetWidth: number;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.offsetWidth

onabort

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onabort

onanimationcancel

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onanimationcancel

onanimationend

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onanimationend

onanimationiteration

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onanimationiteration

onanimationstart

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onanimationstart

onauxclick

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onauxclick

onbeforeinput

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onbeforeinput

onbeforematch

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onbeforematch

onbeforetoggle

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onbeforetoggle

onblur

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onblur

oncancel

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncancel

oncanplay

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncanplay

oncanplaythrough

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncanplaythrough

onchange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onchange

onclick

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onclick

onclose

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onclose

oncommand

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncommand

oncontextlost

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncontextlost

oncontextmenu

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncontextmenu

oncontextrestored

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncontextrestored

oncopy

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncopy

oncuechange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncuechange

oncut

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oncut

ondblclick

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondblclick

ondrag

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondrag

ondragend

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondragend

ondragenter

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondragenter

ondragleave

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondragleave

ondragover

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondragover

ondragstart

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondragstart

ondrop

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondrop

ondurationchange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ondurationchange

onemptied

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onemptied

onended

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onended

onerror

ts
onerror: OnErrorEventHandler;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onerror

onfocus

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onfocus

onformdata

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onformdata

onfullscreenchange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onfullscreenchange

onfullscreenerror

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onfullscreenerror

ongotpointercapture

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ongotpointercapture

oninput

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oninput

oninvalid

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.oninvalid

onkeydown

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onkeydown

onkeypress

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

Defined in: typescript:

Deprecated

MDN Reference

Inherited from

ts
ReactiveElement.onkeypress

onkeyup

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onkeyup

onload

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onload

onloadeddata

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onloadeddata

onloadedmetadata

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onloadedmetadata

onloadstart

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onloadstart

onlostpointercapture

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onlostpointercapture

onmousedown

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmousedown

onmouseenter

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmouseenter

onmouseleave

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmouseleave

onmousemove

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmousemove

onmouseout

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmouseout

onmouseover

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmouseover

onmouseup

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onmouseup

onpaste

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpaste

onpause

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpause

onplay

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onplay

onplaying

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onplaying

onpointercancel

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointercancel

onpointerdown

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerdown

onpointerenter

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerenter

onpointerleave

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerleave

onpointermove

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointermove

onpointerout

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerout

onpointerover

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerover

onpointerrawupdate

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

Defined in: typescript:

Available only in secure contexts.

MDN Reference

Inherited from

ts
ReactiveElement.onpointerrawupdate

onpointerup

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onpointerup

onprogress

ts
onprogress: 
  | ((this: GlobalEventHandlers, ev: ProgressEvent) => any)
  | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onprogress

onratechange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onratechange

onreset

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onreset

onresize

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onresize

onscroll

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onscroll

onscrollend

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onscrollend

onsecuritypolicyviolation

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onsecuritypolicyviolation

onseeked

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onseeked

onseeking

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onseeking

onselect

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onselect

onselectionchange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onselectionchange

onselectstart

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onselectstart

onslotchange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onslotchange

onstalled

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onstalled

onsubmit

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onsubmit

onsuspend

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onsuspend

ontimeupdate

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontimeupdate

ontoggle

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontoggle

ontouchcancel?

ts
optional ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontouchcancel

ontouchend?

ts
optional ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontouchend

ontouchmove?

ts
optional ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontouchmove

ontouchstart?

ts
optional ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontouchstart

ontransitioncancel

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontransitioncancel

ontransitionend

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontransitionend

ontransitionrun

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontransitionrun

ontransitionstart

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.ontransitionstart

onvolumechange

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onvolumechange

onwaiting

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onwaiting

onwebkitanimationend

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

Defined in: typescript:

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

Inherited from

ts
ReactiveElement.onwebkitanimationend

onwebkitanimationiteration

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

Defined in: typescript:

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

Inherited from

ts
ReactiveElement.onwebkitanimationiteration

onwebkitanimationstart

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

Defined in: typescript:

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

Inherited from

ts
ReactiveElement.onwebkitanimationstart

onwebkittransitionend

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

Defined in: typescript:

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

Inherited from

ts
ReactiveElement.onwebkittransitionend

onwheel

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

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.onwheel

outerHTML

ts
outerHTML: string;

Defined in: typescript:

The outerHTML attribute of the Element interface gets or sets the HTML or XML markup of the element and its descendants, omitting any shadow roots in both cases.

MDN Reference

Inherited from

ts
ReactiveElement.outerHTML

outerText

ts
outerText: string;

Defined in: typescript:

The outerText property of the HTMLElement interface returns the same value as HTMLElement.innerText. When used as a setter it replaces the whole current node with the given text (this differs from innerText, which replaces the content inside the current node).

MDN Reference

Inherited from

ts
ReactiveElement.outerText

ownerDocument

ts
readonly ownerDocument: Document;

Defined in: typescript:

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

MDN Reference

Inherited from

ts
ReactiveElement.ownerDocument

parentElement

ts
readonly parentElement: HTMLElement | null;

Defined in: typescript:

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. Node.parentNode on the other hand returns any kind of parent, regardless of its type.

MDN Reference

Inherited from

SignalWatcher.parentElement


parentNode

ts
readonly parentNode: ParentNode | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.parentNode


popover

ts
popover: string | null;

Defined in: typescript:

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

Inherited from

SignalWatcher.popover


prefix

ts
readonly prefix: string | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.prefix


previousElementSibling

ts
readonly previousElementSibling: Element | null;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.previousElementSibling

previousSibling

ts
readonly previousSibling: ChildNode | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.previousSibling


PROCESSING_INSTRUCTION_NODE

ts
readonly PROCESSING_INSTRUCTION_NODE: 7;

Defined in: typescript:

node is a ProcessingInstruction node.

Inherited from

ts
ReactiveElement.PROCESSING_INSTRUCTION_NODE

role

ts
role: string | null;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.role

scrollHeight

ts
readonly scrollHeight: number;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.scrollHeight

scrollLeft

ts
scrollLeft: number;

Defined in: typescript:

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. This value is subpixel precise in modern browsers, meaning that it isn't necessarily a whole number.

MDN Reference

Inherited from

ts
ReactiveElement.scrollLeft

scrollTop

ts
scrollTop: number;

Defined in: typescript:

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. This value is subpixel precise in modern browsers, meaning that it isn't necessarily a whole number.

MDN Reference

Inherited from

ts
ReactiveElement.scrollTop

scrollWidth

ts
readonly scrollWidth: number;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.scrollWidth

shadowRoot

ts
readonly shadowRoot: ShadowRoot | null;

Defined in: typescript:

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

MDN Reference

Inherited from

SignalWatcher.shadowRoot


slot

ts
slot: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.slot

spellcheck

ts
spellcheck: boolean;

Defined in: typescript:

The spellcheck property of the HTMLElement interface represents a boolean value that controls the spell-checking hint. It is available on all HTML elements, though it doesn't affect all of them.

MDN Reference

Inherited from

ts
ReactiveElement.spellcheck

tabIndex

ts
tabIndex: number;

Defined in: typescript:

MDN Reference

Inherited from

ts
ReactiveElement.tabIndex

tagName

ts
readonly tagName: string;

Defined in: typescript:

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

MDN Reference

Inherited from

ts
ReactiveElement.tagName

TEXT_NODE

ts
readonly TEXT_NODE: 3;

Defined in: typescript:

node is a Text node.

Inherited from

ts
ReactiveElement.TEXT_NODE

title

ts
title: string;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.title

translate

ts
translate: boolean;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.translate

writingSuggestions

ts
writingSuggestions: string;

Defined in: typescript:

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

Inherited from

ts
ReactiveElement.writingSuggestions

classList

Get Signature

ts
get classList(): DOMTokenList;

Defined in: typescript:

The read-only classList property of the Element interface contains a live DOMTokenList collection representing the class attribute of the element. This can then be used to manipulate the class list.

MDN Reference

Returns

DOMTokenList

Set Signature

ts
set classList(value: string): void;

Defined in: typescript:

Parameters
ParameterType
valuestring
Returns

void

Inherited from

ts
ReactiveElement.classList

part

Get Signature

ts
get part(): DOMTokenList;

Defined in: typescript:

The read-only part property of the Element interface contains a DOMTokenList object representing the part identifier(s) of the element. It reflects the element's part content attribute. These can be used to style parts of a shadow DOM, via the ::part pseudo-element.

MDN Reference

Returns

DOMTokenList

Set Signature

ts
set part(value: string): void;

Defined in: typescript:

Parameters
ParameterType
valuestring
Returns

void

Inherited from

ts
ReactiveElement.part

style

Get Signature

ts
get style(): CSSStyleDeclaration;

Defined in: typescript:

MDN Reference

Returns

CSSStyleDeclaration

Set Signature

ts
set style(cssText: string): void;

Defined in: typescript:

Parameters
ParameterType
cssTextstring
Returns

void

Inherited from

ts
ReactiveElement.style

textContent

Get Signature

ts
get textContent(): string;

Defined in: typescript:

MDN Reference

Returns

string

Set Signature

ts
set textContent(value: string | null): void;

Defined in: typescript:

The textContent property of the Node interface represents the text content of the node and its descendants.

MDN Reference

Parameters
ParameterType
valuestring | null
Returns

void

Inherited from

ts
ReactiveElement.textContent

addEventListener()

Call Signature

ts
addEventListener<K>(
   type: K, 
   listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, 
   options?: boolean | AddEventListenerOptions): void;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof HTMLElementEventMap
Parameters
ParameterType
typeK
listener(this: HTMLElement, ev: HTMLElementEventMap[K]) => any
options?boolean | AddEventListenerOptions
Returns

void

Inherited from
ts
ReactiveElement.addEventListener

Call Signature

ts
addEventListener(
   type: string, 
   listener: EventListenerOrEventListenerObject, 
   options?: boolean | AddEventListenerOptions): void;

Defined in: typescript:

Parameters
ParameterType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | AddEventListenerOptions
Returns

void

Inherited from
ts
ReactiveElement.addEventListener

after()

ts
after(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.after

animate()

ts
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;

Defined in: typescript:

MDN Reference

Parameters

ParameterType
keyframesKeyframe[] | PropertyIndexedKeyframes | null
options?number | KeyframeAnimationOptions

Returns

Animation

Inherited from

ts
ReactiveElement.animate

append()

ts
append(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.append

appendChild()

ts
appendChild<T>(node: T): T;

Defined in: typescript:

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

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeT

Returns

T

Inherited from

ts
ReactiveElement.appendChild

attachInternals()

ts
attachInternals(): ElementInternals;

Defined in: typescript:

The HTMLElement.attachInternals() method returns an ElementInternals object. This method allows a custom element to participate in HTML forms. The ElementInternals interface provides utilities for working with these elements in the same way you would work with any standard HTML form element, and also exposes the Accessibility Object Model to the element.

MDN Reference

Returns

ElementInternals

Inherited from

ts
ReactiveElement.attachInternals

attachShadow()

ts
attachShadow(init: ShadowRootInit): ShadowRoot;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
initShadowRootInit

Returns

ShadowRoot

Inherited from

ts
ReactiveElement.attachShadow

before()

ts
before(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.before

blur()

ts
blur(): void;

Defined in: typescript:

MDN Reference

Returns

void

Inherited from

ts
ReactiveElement.blur

checkVisibility()

ts
checkVisibility(options?: CheckVisibilityOptions): boolean;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?CheckVisibilityOptions

Returns

boolean

Inherited from

ts
ReactiveElement.checkVisibility

click()

ts
click(): void;

Defined in: typescript:

The HTMLElement.click() method simulates a mouse click on an element. When called on an element, the element's click event is fired (unless its disabled attribute is set).

MDN Reference

Returns

void

Inherited from

ts
ReactiveElement.click

cloneNode()

ts
cloneNode(subtree?: boolean): Node;

Defined in: typescript:

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in the node is also cloned or not.

MDN Reference

Parameters

ParameterType
subtree?boolean

Returns

Node

Inherited from

ts
ReactiveElement.cloneNode

closest()

Call Signature

ts
closest<K>(selector: K): HTMLElementTagNameMap[K] | null;

Defined in: typescript:

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

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorK
Returns

HTMLElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.closest

Call Signature

ts
closest<K>(selector: K): SVGElementTagNameMap[K] | null;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorK
Returns

SVGElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.closest

Call Signature

ts
closest<K>(selector: K): MathMLElementTagNameMap[K] | null;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorK
Returns

MathMLElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.closest

Call Signature

ts
closest<E>(selectors: string): E | null;

Defined in: typescript:

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

E | null

Inherited from
ts
ReactiveElement.closest

compareDocumentPosition()

ts
compareDocumentPosition(other: Node): number;

Defined in: typescript:

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

Parameters

ParameterType
otherNode

Returns

number

Inherited from

ts
ReactiveElement.compareDocumentPosition

computedStyleMap()

ts
computedStyleMap(): StylePropertyMapReadOnly;

Defined in: typescript:

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

Returns

StylePropertyMapReadOnly

Inherited from

ts
ReactiveElement.computedStyleMap

contains()

ts
contains(other: Node | null): boolean;

Defined in: typescript:

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 (childNodes), one of the children's direct children, and so on.

MDN Reference

Parameters

ParameterType
otherNode | null

Returns

boolean

Inherited from

ts
ReactiveElement.contains

dispatchEvent()

ts
dispatchEvent(event: Event): boolean;

Defined in: typescript:

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

ParameterType
eventEvent

Returns

boolean

Inherited from

ts
ReactiveElement.dispatchEvent

focus()

ts
focus(options?: FocusOptions): void;

Defined in: typescript:

MDN Reference

Parameters

ParameterType
options?FocusOptions

Returns

void

Inherited from

ts
ReactiveElement.focus

getAnimations()

ts
getAnimations(options?: GetAnimationsOptions): Animation[];

Defined in: typescript:

MDN Reference

Parameters

ParameterType
options?GetAnimationsOptions

Returns

Animation[]

Inherited from

ts
ReactiveElement.getAnimations

getAttribute()

ts
getAttribute(qualifiedName: string): string | null;

Defined in: typescript:

The getAttribute() method of the Element interface returns the value of a specified attribute on the element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

string | null

Inherited from

ts
ReactiveElement.getAttribute

getAttributeNames()

ts
getAttributeNames(): string[];

Defined in: typescript:

The getAttributeNames() method of the Element interface returns the attribute names of the element as an Array of strings. If the element has no attributes it returns an empty array.

MDN Reference

Returns

string[]

Inherited from

ts
ReactiveElement.getAttributeNames

getAttributeNode()

ts
getAttributeNode(qualifiedName: string): Attr | null;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

Attr | null

Inherited from

ts
ReactiveElement.getAttributeNode

getAttributeNodeNS()

ts
getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

Attr | null

Inherited from

ts
ReactiveElement.getAttributeNodeNS

getAttributeNS()

ts
getAttributeNS(namespace: string | null, localName: string): string | null;

Defined in: typescript:

The getAttributeNS() method of the Element interface returns the string value of the attribute with the specified namespace and name. If the named attribute does not exist, the value returned will either be null or "" (the empty string); see Notes for details.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

string | null

Inherited from

ts
ReactiveElement.getAttributeNS

getBoundingClientRect()

ts
getBoundingClientRect(): DOMRect;

Defined in: typescript:

The Element.getBoundingClientRect() method returns a DOMRect object providing information about the size of an element and its position relative to the viewport.

MDN Reference

Returns

DOMRect

Inherited from

ts
ReactiveElement.getBoundingClientRect

getClientRects()

ts
getClientRects(): DOMRectList;

Defined in: typescript:

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

Returns

DOMRectList

Inherited from

ts
ReactiveElement.getClientRects

getElementsByClassName()

ts
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;

Defined in: typescript:

The Element method getElementsByClassName() returns a live HTMLCollection which contains every descendant element which has the specified class name or names.

MDN Reference

Parameters

ParameterType
classNamesstring

Returns

HTMLCollectionOf<Element>

Inherited from

ts
ReactiveElement.getElementsByClassName

getElementsByTagName()

Call Signature

ts
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;

Defined in: typescript:

The Element.getElementsByTagName() method returns a live HTMLCollection of elements with the given tag name.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.getElementsByTagName

Call Signature

ts
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.getElementsByTagName

Call Signature

ts
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.getElementsByTagName

Call Signature

ts
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated
Inherited from
ts
ReactiveElement.getElementsByTagName

Call Signature

ts
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;

Defined in: typescript:

Parameters
ParameterType
qualifiedNamestring
Returns

HTMLCollectionOf<Element>

Inherited from
ts
ReactiveElement.getElementsByTagName

getElementsByTagNameNS()

Call Signature

ts
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;

Defined in: typescript:

The Element.getElementsByTagNameNS() method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace. It is similar to Document.getElementsByTagNameNS, except that its search is restricted to descendants of the specified element.

MDN Reference

Parameters
ParameterType
namespaceURI"http://www.w3.org/1999/xhtml"
localNamestring
Returns

HTMLCollectionOf<HTMLElement>

Inherited from
ts
ReactiveElement.getElementsByTagNameNS

Call Signature

ts
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;

Defined in: typescript:

Parameters
ParameterType
namespaceURI"http://www.w3.org/2000/svg"
localNamestring
Returns

HTMLCollectionOf<SVGElement>

Inherited from
ts
ReactiveElement.getElementsByTagNameNS

Call Signature

ts
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;

Defined in: typescript:

Parameters
ParameterType
namespaceURI"http://www.w3.org/1998/Math/MathML"
localNamestring
Returns

HTMLCollectionOf<MathMLElement>

Inherited from
ts
ReactiveElement.getElementsByTagNameNS

Call Signature

ts
getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;

Defined in: typescript:

Parameters
ParameterType
namespacestring | null
localNamestring
Returns

HTMLCollectionOf<Element>

Inherited from
ts
ReactiveElement.getElementsByTagNameNS

getHTML()

ts
getHTML(options?: GetHTMLOptions): string;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?GetHTMLOptions

Returns

string

Inherited from

ts
ReactiveElement.getHTML

getRootNode()

ts
getRootNode(options?: GetRootNodeOptions): Node;

Defined in: typescript:

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

Parameters

ParameterType
options?GetRootNodeOptions

Returns

Node

Inherited from

ts
ReactiveElement.getRootNode

hasAttribute()

ts
hasAttribute(qualifiedName: string): boolean;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

boolean

Inherited from

ts
ReactiveElement.hasAttribute

hasAttributeNS()

ts
hasAttributeNS(namespace: string | null, localName: string): boolean;

Defined in: typescript:

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

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

boolean

Inherited from

ts
ReactiveElement.hasAttributeNS

hasAttributes()

ts
hasAttributes(): boolean;

Defined in: typescript:

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

MDN Reference

Returns

boolean

Inherited from

ts
ReactiveElement.hasAttributes

hasChildNodes()

ts
hasChildNodes(): boolean;

Defined in: typescript:

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

MDN Reference

Returns

boolean

Inherited from

ts
ReactiveElement.hasChildNodes

hasPointerCapture()

ts
hasPointerCapture(pointerId: number): boolean;

Defined in: typescript:

The hasPointerCapture() method of the Element interface checks whether the element on which it is invoked has pointer capture for the pointer identified by the given pointer ID.

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

boolean

Inherited from

ts
ReactiveElement.hasPointerCapture

hidePopover()

ts
hidePopover(): void;

Defined in: typescript:

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

Returns

void

Inherited from

ts
ReactiveElement.hidePopover

insertAdjacentElement()

ts
insertAdjacentElement(where: InsertPosition, element: Element): Element | null;

Defined in: typescript:

The insertAdjacentElement() method of the Element interface inserts a given element node at a given position relative to the element it is invoked upon.

MDN Reference

Parameters

ParameterType
whereInsertPosition
elementElement

Returns

Element | null

Inherited from

ts
ReactiveElement.insertAdjacentElement

insertAdjacentHTML()

ts
insertAdjacentHTML(position: InsertPosition, string: string): void;

Defined in: typescript:

The insertAdjacentHTML() method of the Element interface parses the specified input as HTML or XML and inserts the resulting nodes into the DOM tree at a specified position.

MDN Reference

Parameters

ParameterType
positionInsertPosition
stringstring

Returns

void

Inherited from

ts
ReactiveElement.insertAdjacentHTML

insertAdjacentText()

ts
insertAdjacentText(where: InsertPosition, data: string): void;

Defined in: typescript:

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

Parameters

ParameterType
whereInsertPosition
datastring

Returns

void

Inherited from

ts
ReactiveElement.insertAdjacentText

insertBefore()

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

Defined in: typescript:

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

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeT
childNode | null

Returns

T

Inherited from

ts
ReactiveElement.insertBefore

isDefaultNamespace()

ts
isDefaultNamespace(namespace: string | null): boolean;

Defined in: typescript:

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not. The default namespace can be retrieved with Node.lookupNamespaceURI() by passing null as the argument.

MDN Reference

Parameters

ParameterType
namespacestring | null

Returns

boolean

Inherited from

ts
ReactiveElement.isDefaultNamespace

isEqualNode()

ts
isEqualNode(otherNode: Node | null): boolean;

Defined in: typescript:

The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes.

MDN Reference

Parameters

ParameterType
otherNodeNode | null

Returns

boolean

Inherited from

ts
ReactiveElement.isEqualNode

isSameNode()

ts
isSameNode(otherNode: Node | null): boolean;

Defined in: typescript:

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).

MDN Reference

Parameters

ParameterType
otherNodeNode | null

Returns

boolean

Inherited from

ts
ReactiveElement.isSameNode

lookupNamespaceURI()

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

Defined in: typescript:

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). This method's existence allows Node objects to be passed as a namespace resolver to XPathEvaluator.createExpression() and XPathEvaluator.evaluate().

MDN Reference

Parameters

ParameterType
prefixstring | null

Returns

string | null

Inherited from

ts
ReactiveElement.lookupNamespaceURI

lookupPrefix()

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

Defined in: typescript:

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.

MDN Reference

Parameters

ParameterType
namespacestring | null

Returns

string | null

Inherited from

ts
ReactiveElement.lookupPrefix

matches()

Call Signature

ts
matches<K>(selectors: K): this is HTMLElementTagNameMap[K];

Defined in: typescript:

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

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

this is HTMLElementTagNameMap[K]

Inherited from
ts
ReactiveElement.matches

Call Signature

ts
matches<K>(selectors: K): this is SVGElementTagNameMap[K];

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

this is SVGElementTagNameMap[K]

Inherited from
ts
ReactiveElement.matches

Call Signature

ts
matches<K>(selectors: K): this is MathMLElementTagNameMap[K];

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

this is MathMLElementTagNameMap[K]

Inherited from
ts
ReactiveElement.matches

Call Signature

ts
matches(selectors: string): boolean;

Defined in: typescript:

Parameters
ParameterType
selectorsstring
Returns

boolean

Inherited from
ts
ReactiveElement.matches

moveBefore()

ts
moveBefore(node: Node, child: Node | null): void;

Defined in: typescript:

MDN Reference

Parameters

ParameterType
nodeNode
childNode | null

Returns

void

Inherited from

ts
ReactiveElement.moveBefore

normalize()

ts
normalize(): void;

Defined in: typescript:

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

MDN Reference

Returns

void

Inherited from

ts
ReactiveElement.normalize

prepend()

ts
prepend(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.prepend

querySelector()

Call Signature

ts
querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null;

Defined in: typescript:

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

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

HTMLElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.querySelector

Call Signature

ts
querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

SVGElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.querySelector

Call Signature

ts
querySelector<K>(selectors: K): MathMLElementTagNameMap[K] | null;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

MathMLElementTagNameMap[K] | null

Inherited from
ts
ReactiveElement.querySelector

Call Signature

ts
querySelector<K>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
selectorsK
Returns

HTMLElementDeprecatedTagNameMap[K] | null

Deprecated
Inherited from
ts
ReactiveElement.querySelector

Call Signature

ts
querySelector<E>(selectors: string): E | null;

Defined in: typescript:

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

E | null

Inherited from
ts
ReactiveElement.querySelector

querySelectorAll()

Call Signature

ts
querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;

Defined in: typescript:

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.querySelectorAll

Call Signature

ts
querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.querySelectorAll

Call Signature

ts
querySelectorAll<K>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<MathMLElementTagNameMap[K]>

Inherited from
ts
ReactiveElement.querySelectorAll

Call Signature

ts
querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated
Inherited from
ts
ReactiveElement.querySelectorAll

Call Signature

ts
querySelectorAll<E>(selectors: string): NodeListOf<E>;

Defined in: typescript:

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

NodeListOf<E>

Inherited from
ts
ReactiveElement.querySelectorAll

releasePointerCapture()

ts
releasePointerCapture(pointerId: number): void;

Defined in: typescript:

The releasePointerCapture() method of the Element interface releases (stops) pointer capture that was previously set for a specific (PointerEvent) pointer.

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

void

Inherited from

ts
ReactiveElement.releasePointerCapture

remove()

ts
remove(): void;

Defined in: typescript:

Removes node.

MDN Reference

Returns

void

Inherited from

ts
ReactiveElement.remove

removeAttribute()

ts
removeAttribute(qualifiedName: string): void;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

void

Inherited from

ts
ReactiveElement.removeAttribute

removeAttributeNode()

ts
removeAttributeNode(attr: Attr): Attr;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr

Inherited from

ts
ReactiveElement.removeAttributeNode

removeAttributeNS()

ts
removeAttributeNS(namespace: string | null, localName: string): void;

Defined in: typescript:

The removeAttributeNS() method of the Element interface removes the specified attribute with the specified namespace from an element.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

void

Inherited from

ts
ReactiveElement.removeAttributeNS

removeChild()

ts
removeChild<T>(child: T): T;

Defined in: typescript:

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

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
childT

Returns

T

Inherited from

ts
ReactiveElement.removeChild

removeEventListener()

Call Signature

ts
removeEventListener<K>(
   type: K, 
   listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, 
   options?: boolean | EventListenerOptions): void;

Defined in: typescript:

Type Parameters
Type Parameter
K extends keyof HTMLElementEventMap
Parameters
ParameterType
typeK
listener(this: HTMLElement, ev: HTMLElementEventMap[K]) => any
options?boolean | EventListenerOptions
Returns

void

Inherited from
ts
ReactiveElement.removeEventListener

Call Signature

ts
removeEventListener(
   type: string, 
   listener: EventListenerOrEventListenerObject, 
   options?: boolean | EventListenerOptions): void;

Defined in: typescript:

Parameters
ParameterType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | EventListenerOptions
Returns

void

Inherited from
ts
ReactiveElement.removeEventListener

replaceChild()

ts
replaceChild<T>(node: Node, child: T): T;

Defined in: typescript:

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

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeNode
childT

Returns

T

Inherited from

ts
ReactiveElement.replaceChild

replaceChildren()

ts
replaceChildren(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.replaceChildren

replaceWith()

ts
replaceWith(...nodes: (string | Node)[]): void;

Defined in: typescript:

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ts
ReactiveElement.replaceWith

requestFullscreen()

ts
requestFullscreen(options?: FullscreenOptions): Promise<void>;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?FullscreenOptions

Returns

Promise<void>

Inherited from

ts
ReactiveElement.requestFullscreen

requestPointerLock()

ts
requestPointerLock(options?: PointerLockOptions): Promise<void>;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?PointerLockOptions

Returns

Promise<void>

Inherited from

ts
ReactiveElement.requestPointerLock

scroll()

Call Signature

ts
scroll(options?: ScrollToOptions): void;

Defined in: typescript:

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

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Inherited from
ts
ReactiveElement.scroll

Call Signature

ts
scroll(x: number, y: number): void;

Defined in: typescript:

Parameters
ParameterType
xnumber
ynumber
Returns

void

Inherited from
ts
ReactiveElement.scroll

scrollBy()

Call Signature

ts
scrollBy(options?: ScrollToOptions): void;

Defined in: typescript:

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

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Inherited from
ts
ReactiveElement.scrollBy

Call Signature

ts
scrollBy(x: number, y: number): void;

Defined in: typescript:

Parameters
ParameterType
xnumber
ynumber
Returns

void

Inherited from
ts
ReactiveElement.scrollBy

scrollIntoView()

ts
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;

Defined in: typescript:

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

Parameters

ParameterType
arg?boolean | ScrollIntoViewOptions

Returns

void

Inherited from

ts
ReactiveElement.scrollIntoView

scrollTo()

Call Signature

ts
scrollTo(options?: ScrollToOptions): void;

Defined in: typescript:

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

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Inherited from
ts
ReactiveElement.scrollTo

Call Signature

ts
scrollTo(x: number, y: number): void;

Defined in: typescript:

Parameters
ParameterType
xnumber
ynumber
Returns

void

Inherited from
ts
ReactiveElement.scrollTo

setAttribute()

ts
setAttribute(qualifiedName: string, value: string): void;

Defined in: typescript:

The setAttribute() method of the Element interface sets the value of an attribute on the specified element. If the attribute already exists, the value is updated; otherwise a new attribute is added with the specified name and value.

MDN Reference

Parameters

ParameterType
qualifiedNamestring
valuestring

Returns

void

Inherited from

ts
ReactiveElement.setAttribute

setAttributeNode()

ts
setAttributeNode(attr: Attr): Attr | null;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr | null

Inherited from

ts
ReactiveElement.setAttributeNode

setAttributeNodeNS()

ts
setAttributeNodeNS(attr: Attr): Attr | null;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr | null

Inherited from

ts
ReactiveElement.setAttributeNodeNS

setAttributeNS()

ts
setAttributeNS(
   namespace: string | null, 
   qualifiedName: string, 
   value: string): void;

Defined in: typescript:

The setAttributeNS() method of the Element interface adds a new attribute or changes the value of an attribute with the given namespace and name.

MDN Reference

Parameters

ParameterType
namespacestring | null
qualifiedNamestring
valuestring

Returns

void

Inherited from

ts
ReactiveElement.setAttributeNS

setHTMLUnsafe()

ts
setHTMLUnsafe(html: string): void;

Defined in: typescript:

The setHTMLUnsafe() method of the Element interface is used to parse HTML input 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

Parameters

ParameterType
htmlstring

Returns

void

Inherited from

ts
ReactiveElement.setHTMLUnsafe

setPointerCapture()

ts
setPointerCapture(pointerId: number): void;

Defined in: typescript:

The setPointerCapture() method of the Element interface is used to designate a specific element as the capture target of future pointer events. Subsequent events for the pointer will be targeted at the capture element until capture is released (via Element.releasePointerCapture() or the pointerup event is fired).

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

void

Inherited from

ts
ReactiveElement.setPointerCapture

showPopover()

ts
showPopover(options?: ShowPopoverOptions): void;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?ShowPopoverOptions

Returns

void

Inherited from

ts
ReactiveElement.showPopover

toggleAttribute()

ts
toggleAttribute(qualifiedName: string, force?: boolean): boolean;

Defined in: typescript:

The toggleAttribute() method of the Element interface toggles a Boolean attribute (removing it if it is present and adding it if it is not present) on the given element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring
force?boolean

Returns

boolean

Inherited from

ts
ReactiveElement.toggleAttribute

togglePopover()

ts
togglePopover(options?: boolean | TogglePopoverOptions): boolean;

Defined in: typescript:

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

MDN Reference

Parameters

ParameterType
options?boolean | TogglePopoverOptions

Returns

boolean

Inherited from

ts
ReactiveElement.togglePopover

webkitMatchesSelector()

ts
webkitMatchesSelector(selectors: string): boolean;

Defined in: typescript:

Parameters

ParameterType
selectorsstring

Returns

boolean

Deprecated

This is a legacy alias of matches.

MDN Reference

Inherited from

ts
ReactiveElement.webkitMatchesSelector

attributes

attributeChangedCallback()

ts
attributeChangedCallback(
   name: string, 
   _old: string | null, 
   value: string | null): void;

Defined in: @lit/reactive-element:

Synchronizes property values when attributes change.

Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.

See responding to attribute changes on MDN for more information about the attributeChangedCallback.

Parameters

ParameterType
namestring
_oldstring | null
valuestring | null

Returns

void

Inherited from

ts
ReactiveElement.attributeChangedCallback

controllers

addController()

ts
addController(controller: ReactiveController): void;

Defined in: @lit/reactive-element:

Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.

If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.

Parameters

ParameterType
controllerReactiveController

Returns

void

Inherited from

ts
ReactiveElement.addController

removeController()

ts
removeController(controller: ReactiveController): void;

Defined in: @lit/reactive-element:

Removes a ReactiveController from the element.

Parameters

ParameterType
controllerReactiveController

Returns

void

Inherited from

ts
ReactiveElement.removeController

lifecycle

connectedCallback()

ts
connectedCallback(): void;

Defined in: @lit/reactive-element:

On first connection, creates the element's renderRoot, sets up element styling, and enables updating.

Returns

void

Inherited from

ts
ReactiveElement.connectedCallback

disconnectedCallback()

ts
disconnectedCallback(): void;

Defined in: @lit/reactive-element:

Allows for super.disconnectedCallback() in extensions while reserving the possibility of making non-breaking feature additions when disconnecting at some point in the future.

Returns

void

Inherited from

ts
ReactiveElement.disconnectedCallback

rendering

renderRoot

ts
readonly renderRoot: HTMLElement | DocumentFragment;

Defined in: @lit/reactive-element:

Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.

Inherited from

SignalWatcher.renderRoot


createRenderRoot()

ts
protected createRenderRoot(): HTMLElement | DocumentFragment;

Defined in: @lit/reactive-element:

Returns the node into which the element should render and by default creates and returns an open shadowRoot. Implement to customize where the element's DOM is rendered. For example, to render into the element's childNodes, return this.

Returns

HTMLElement | DocumentFragment

Returns a node into which to render.

Inherited from

ts
ReactiveElement.createRenderRoot

updates

hasUpdated

ts
hasUpdated: boolean;

Defined in: @lit/reactive-element:

Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.

Inherited from

ts
ReactiveElement.hasUpdated

isUpdatePending

ts
isUpdatePending: boolean;

Defined in: @lit/reactive-element:

True if there is a pending update as a result of calling requestUpdate(). Should only be read.

Inherited from

ts
ReactiveElement.isUpdatePending

updateComplete

Get Signature

ts
get updateComplete(): Promise<boolean>;

Defined in: @lit/reactive-element:

Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.

To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.

Returns

Promise<boolean>

A promise of a boolean that resolves to true if the update completed without triggering another update.

Inherited from

ts
ReactiveElement.updateComplete

enableUpdating()

ts
protected enableUpdating(_requestedUpdate: boolean): void;

Defined in: @lit/reactive-element:

Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.

Parameters

ParameterType
_requestedUpdateboolean

Returns

void

Inherited from

ts
ReactiveElement.enableUpdating

firstUpdated()

ts
protected firstUpdated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;

Defined in: @lit/reactive-element:

Invoked when the element is first updated. Implement to perform one time work on the element after update.

ts
firstUpdated() {
  this.renderRoot.getElementById('my-text-area').focus();
}

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters

ParameterTypeDescription
_changedPropertiesPropertyValueMap<any> | Map<PropertyKey, unknown>Map of changed properties with old values

Returns

void

Inherited from

ts
ReactiveElement.firstUpdated

getUpdateComplete()

ts
protected getUpdateComplete(): Promise<boolean>;

Defined in: @lit/reactive-element:

Override point for the updateComplete promise.

It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:

ts
class MyElement extends LitElement {
  override async getUpdateComplete() {
    const result = await super.getUpdateComplete();
    await this._myChild.updateComplete;
    return result;
  }
}

Returns

Promise<boolean>

A promise of a boolean that resolves to true if the update completed without triggering another update.

Inherited from

ts
ReactiveElement.getUpdateComplete

performUpdate()

ts
protected performUpdate(): void;

Defined in: @lit/reactive-element:

Performs an element update. Note, if an exception is thrown during the update, firstUpdated and updated will not be called.

Call performUpdate() to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.

Returns

void

Inherited from

ts
ReactiveElement.performUpdate

requestUpdate()

ts
requestUpdate(
   name?: PropertyKey, 
   oldValue?: unknown, 
   options?: PropertyDeclaration<unknown, unknown>, 
   useNewValue?: boolean, 
   newValue?: unknown): void;

Defined in: @lit/reactive-element:

Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored.

Parameters

ParameterTypeDescription
name?PropertyKeyname of requesting property
oldValue?unknownold value of requesting property
options?PropertyDeclaration<unknown, unknown>property options to use instead of the previously configured options
useNewValue?booleanif true, the newValue argument is used instead of reading the property value. This is important to use if the reactive property is a standard private accessor, as opposed to a plain property, since private members can't be dynamically read by name.
newValue?unknownthe new value of the property. This is only used if useNewValue is true.

Returns

void

Inherited from

ts
ReactiveElement.requestUpdate

scheduleUpdate()

ts
protected scheduleUpdate(): void | Promise<unknown>;

Defined in: @lit/reactive-element:

Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.

For instance, to schedule updates to occur just before the next frame:

ts
override protected async scheduleUpdate(): Promise<unknown> {
  await new Promise((resolve) => requestAnimationFrame(() => resolve()));
  super.scheduleUpdate();
}

Returns

void | Promise<unknown>

Inherited from

ts
ReactiveElement.scheduleUpdate

shouldUpdate()

ts
protected shouldUpdate(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): boolean;

Defined in: @lit/reactive-element:

Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.

Parameters

ParameterTypeDescription
_changedPropertiesPropertyValueMap<any> | Map<PropertyKey, unknown>Map of changed properties with old values

Returns

boolean

Inherited from

ts
ReactiveElement.shouldUpdate

update()

ts
protected update(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;

Defined in: @lit/reactive-element:

Updates the element. This method reflects property values to attributes. It can be overridden to render and keep updated element DOM. Setting properties inside this method will not trigger another update.

Parameters

ParameterTypeDescription
_changedPropertiesPropertyValueMap<any> | Map<PropertyKey, unknown>Map of changed properties with old values

Returns

void

Inherited from

ts
ReactiveElement.update

updated()

ts
protected updated(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;

Defined in: @lit/reactive-element:

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

Setting properties inside this method will trigger the element to update again after this update cycle completes.

Parameters

ParameterTypeDescription
_changedPropertiesPropertyValueMap<any> | Map<PropertyKey, unknown>Map of changed properties with old values

Returns

void

Inherited from

ts
ReactiveElement.updated

willUpdate()

ts
protected willUpdate(_changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>): void;

Defined in: @lit/reactive-element:

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

ts
willUpdate(changedProperties) {
  // only need to check changed properties for an expensive computation.
  if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
    this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
  }
}

render() {
  return html`SHA: ${this.sha}`;
}

Parameters

ParameterType
_changedPropertiesPropertyValueMap<any> | Map<PropertyKey, unknown>

Returns

void

Inherited from

ts
ReactiveElement.willUpdate