Interface: SignalWatcher
Defined in: @lit-labs/signals:
See
https://lit.dev/docs/data/signals/
Extends
ReactiveElement
Other
_watcher?
optional _watcher?: Watcher;Defined in: @lit-labs/signals:
accessKey
accessKey: string;Defined in: typescript:
The HTMLElement.accessKey property sets the keystroke which a user can press to jump to a given element.
Inherited from
ReactiveElement.accessKeyaccessKeyLabel
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.
Inherited from
ReactiveElement.accessKeyLabelariaActiveDescendantElement
ariaActiveDescendantElement: Element | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaActiveDescendantElementariaAtomic
ariaAtomic: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaAtomicariaAutoComplete
ariaAutoComplete: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaAutoCompleteariaBrailleLabel
ariaBrailleLabel: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaBrailleLabelariaBrailleRoleDescription
ariaBrailleRoleDescription: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaBrailleRoleDescriptionariaBusy
ariaBusy: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaBusyariaChecked
ariaChecked: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaCheckedariaColCount
ariaColCount: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaColCountariaColIndex
ariaColIndex: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaColIndexariaColIndexText
ariaColIndexText: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaColIndexTextariaColSpan
ariaColSpan: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaColSpanariaControlsElements
ariaControlsElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaControlsElementsariaCurrent
ariaCurrent: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaCurrentariaDescribedByElements
ariaDescribedByElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaDescribedByElementsariaDescription
ariaDescription: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaDescriptionariaDetailsElements
ariaDetailsElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaDetailsElementsariaDisabled
ariaDisabled: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaDisabledariaErrorMessageElements
ariaErrorMessageElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaErrorMessageElementsariaExpanded
ariaExpanded: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaExpandedariaFlowToElements
ariaFlowToElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaFlowToElementsariaHasPopup
ariaHasPopup: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaHasPopupariaHidden
ariaHidden: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaHiddenariaInvalid
ariaInvalid: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaInvalidariaKeyShortcuts
ariaKeyShortcuts: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaKeyShortcutsariaLabel
ariaLabel: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaLabelariaLabelledByElements
ariaLabelledByElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaLabelledByElementsariaLevel
ariaLevel: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaLevelariaLive
ariaLive: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaLiveariaModal
ariaModal: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaModalariaMultiLine
ariaMultiLine: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaMultiLineariaMultiSelectable
ariaMultiSelectable: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaMultiSelectableariaOrientation
ariaOrientation: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaOrientationariaOwnsElements
ariaOwnsElements: readonly Element[] | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaOwnsElementsariaPlaceholder
ariaPlaceholder: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaPlaceholderariaPosInSet
ariaPosInSet: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaPosInSetariaPressed
ariaPressed: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaPressedariaReadOnly
ariaReadOnly: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaReadOnlyariaRelevant
ariaRelevant: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRelevantariaRequired
ariaRequired: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRequiredariaRoleDescription
ariaRoleDescription: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRoleDescriptionariaRowCount
ariaRowCount: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRowCountariaRowIndex
ariaRowIndex: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRowIndexariaRowIndexText
ariaRowIndexText: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRowIndexTextariaRowSpan
ariaRowSpan: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaRowSpanariaSelected
ariaSelected: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaSelectedariaSetSize
ariaSetSize: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaSetSizeariaSort
ariaSort: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaSortariaValueMax
ariaValueMax: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaValueMaxariaValueMin
ariaValueMin: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaValueMinariaValueNow
ariaValueNow: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaValueNowariaValueText
ariaValueText: string | null;Defined in: typescript:
Inherited from
ReactiveElement.ariaValueTextassignedSlot
readonly assignedSlot: HTMLSlotElement | null;Defined in: typescript:
Inherited from
ReactiveElement.assignedSlotATTRIBUTE_NODE
readonly ATTRIBUTE_NODE: 2;Defined in: typescript:
Inherited from
ReactiveElement.ATTRIBUTE_NODEattributes
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.
Inherited from
ReactiveElement.attributesattributeStyleMap
readonly attributeStyleMap: StylePropertyMap;Defined in: typescript:
Inherited from
ReactiveElement.attributeStyleMapautocapitalize
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:
Inherited from
ReactiveElement.autocapitalizeautocorrect
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.
Inherited from
ReactiveElement.autocorrectautofocus
autofocus: boolean;Defined in: typescript:
Inherited from
ReactiveElement.autofocusbaseURI
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.
Inherited from
ReactiveElement.baseURICDATA_SECTION_NODE
readonly CDATA_SECTION_NODE: 4;Defined in: typescript:
node is a CDATASection node.
Inherited from
ReactiveElement.CDATA_SECTION_NODEchildElementCount
readonly childElementCount: number;Defined in: typescript:
Inherited from
ReactiveElement.childElementCountchildNodes
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.
Inherited from
ReactiveElement.childNodeschildren
readonly children: HTMLCollection;Defined in: typescript:
Returns the child elements.
Inherited from
ReactiveElement.childrenclassName
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.
Inherited from
ReactiveElement.classNameclientHeight
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).
Inherited from
ReactiveElement.clientHeightclientLeft
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.
Inherited from
ReactiveElement.clientLeftclientTop
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.
Inherited from
ReactiveElement.clientTopclientWidth
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).
Inherited from
ReactiveElement.clientWidthCOMMENT_NODE
readonly COMMENT_NODE: 8;Defined in: typescript:
node is a Comment node.
Inherited from
ReactiveElement.COMMENT_NODEcontentEditable
contentEditable: string;Defined in: typescript:
Inherited from
ReactiveElement.contentEditablecurrentCSSZoom
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.
Inherited from
ReactiveElement.currentCSSZoomcustomElementRegistry
readonly customElementRegistry: CustomElementRegistry | null;Defined in: typescript:
Inherited from
SignalWatcher.customElementRegistry
dataset
readonly dataset: DOMStringMap;Defined in: typescript:
Inherited from
ReactiveElement.datasetdir
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.
Inherited from
ReactiveElement.dirDOCUMENT_FRAGMENT_NODE
readonly DOCUMENT_FRAGMENT_NODE: 11;Defined in: typescript:
node is a DocumentFragment node.
Inherited from
ReactiveElement.DOCUMENT_FRAGMENT_NODEDOCUMENT_NODE
readonly DOCUMENT_NODE: 9;Defined in: typescript:
node is a document.
Inherited from
ReactiveElement.DOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BY
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;Defined in: typescript:
Set when other is a descendant of node.
Inherited from
ReactiveElement.DOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINS
readonly DOCUMENT_POSITION_CONTAINS: 8;Defined in: typescript:
Set when other is an ancestor of node.
Inherited from
ReactiveElement.DOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTED
readonly DOCUMENT_POSITION_DISCONNECTED: 1;Defined in: typescript:
Set when node and other are not in the same tree.
Inherited from
ReactiveElement.DOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWING
readonly DOCUMENT_POSITION_FOLLOWING: 4;Defined in: typescript:
Set when other is following node.
Inherited from
ReactiveElement.DOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;Defined in: typescript:
Inherited from
ReactiveElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDING
readonly DOCUMENT_POSITION_PRECEDING: 2;Defined in: typescript:
Set when other is preceding node.
Inherited from
ReactiveElement.DOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODE
readonly DOCUMENT_TYPE_NODE: 10;Defined in: typescript:
node is a doctype.
Inherited from
ReactiveElement.DOCUMENT_TYPE_NODEdraggable
draggable: boolean;Defined in: typescript:
The draggable property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.
Inherited from
ReactiveElement.draggableELEMENT_NODE
readonly ELEMENT_NODE: 1;Defined in: typescript:
node is an element.
Inherited from
ReactiveElement.ELEMENT_NODEenterKeyHint
enterKeyHint: string;Defined in: typescript:
Inherited from
ReactiveElement.enterKeyHintENTITY_NODE
readonly ENTITY_NODE: 6;Defined in: typescript:
Inherited from
ReactiveElement.ENTITY_NODEENTITY_REFERENCE_NODE
readonly ENTITY_REFERENCE_NODE: 5;Defined in: typescript:
Inherited from
ReactiveElement.ENTITY_REFERENCE_NODEfirstChild
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.
Inherited from
SignalWatcher.firstChild
firstElementChild
readonly firstElementChild: Element | null;Defined in: typescript:
Returns the first child that is an element, and null otherwise.
Inherited from
SignalWatcher.firstElementChild
hidden
hidden: boolean | "until-found";Defined in: typescript:
The HTMLElement property hidden reflects the value of the element's hidden attribute.
Inherited from
SignalWatcher.hidden
id
id: string;Defined in: typescript:
The id property of the Element interface represents the element's identifier, reflecting the id global attribute.
Inherited from
ReactiveElement.idinert
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.
Inherited from
ReactiveElement.inertinnerHTML
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.
Inherited from
ReactiveElement.innerHTMLinnerText
innerText: string;Defined in: typescript:
The innerText property of the HTMLElement interface represents the rendered text content of a node and its descendants.
Inherited from
ReactiveElement.innerTextinputMode
inputMode: string;Defined in: typescript:
Inherited from
ReactiveElement.inputModeisConnected
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.
Inherited from
ReactiveElement.isConnectedisContentEditable
readonly isContentEditable: boolean;Defined in: typescript:
Inherited from
ReactiveElement.isContentEditablelang
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.
Inherited from
ReactiveElement.langlastChild
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.
Inherited from
SignalWatcher.lastChild
lastElementChild
readonly lastElementChild: Element | null;Defined in: typescript:
Returns the last child that is an element, and null otherwise.
Inherited from
SignalWatcher.lastElementChild
localName
readonly localName: string;Defined in: typescript:
The Element.localName read-only property returns the local part of the qualified name of an element.
Inherited from
ReactiveElement.localNamenamespaceURI
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.
Inherited from
SignalWatcher.namespaceURI
nextElementSibling
readonly nextElementSibling: Element | null;Defined in: typescript:
Returns the first following sibling that is an element, and null otherwise.
Inherited from
ReactiveElement.nextElementSiblingnextSibling
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.
Inherited from
SignalWatcher.nextSibling
nodeName
readonly nodeName: string;Defined in: typescript:
The read-only nodeName property of Node returns the name of the current node as a string.
Inherited from
ReactiveElement.nodeNamenodeType
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.
Inherited from
ReactiveElement.nodeTypenodeValue
nodeValue: string | null;Defined in: typescript:
The nodeValue property of the Node interface returns or sets the value of the current node.
Inherited from
SignalWatcher.nodeValue
nonce
nonce: string;Defined in: typescript:
Inherited from
ReactiveElement.nonceNOTATION_NODE
readonly NOTATION_NODE: 12;Defined in: typescript:
Inherited from
ReactiveElement.NOTATION_NODEoffsetHeight
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.
Inherited from
ReactiveElement.offsetHeightoffsetLeft
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.
Inherited from
ReactiveElement.offsetLeftoffsetParent
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.
Inherited from
SignalWatcher.offsetParent
offsetTop
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.
Inherited from
ReactiveElement.offsetTopoffsetWidth
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.
Inherited from
ReactiveElement.offsetWidthonabort
onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onabortonanimationcancel
onanimationcancel:
| ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onanimationcancelonanimationend
onanimationend:
| ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onanimationendonanimationiteration
onanimationiteration:
| ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onanimationiterationonanimationstart
onanimationstart:
| ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onanimationstartonauxclick
onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onauxclickonbeforeinput
onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onbeforeinputonbeforematch
onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onbeforematchonbeforetoggle
onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onbeforetoggleonblur
onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onbluroncancel
oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncanceloncanplay
oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncanplayoncanplaythrough
oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncanplaythroughonchange
onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onchangeonclick
onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onclickonclose
onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncloseoncommand
oncommand: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncommandoncontextlost
oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncontextlostoncontextmenu
oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncontextmenuoncontextrestored
oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncontextrestoredoncopy
oncopy:
| ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.oncopyoncuechange
oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oncuechangeoncut
oncut:
| ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.oncutondblclick
ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondblclickondrag
ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragondragend
ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragendondragenter
ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragenterondragleave
ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragleaveondragover
ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragoverondragstart
ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondragstartondrop
ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondropondurationchange
ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ondurationchangeonemptied
onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onemptiedonended
onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onendedonerror
onerror: OnErrorEventHandler;Defined in: typescript:
Inherited from
ReactiveElement.onerroronfocus
onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onfocusonformdata
onformdata:
| ((this: GlobalEventHandlers, ev: FormDataEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onformdataonfullscreenchange
onfullscreenchange: ((this: Element, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onfullscreenchangeonfullscreenerror
onfullscreenerror: ((this: Element, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onfullscreenerrorongotpointercapture
ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ongotpointercaptureoninput
oninput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oninputoninvalid
oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.oninvalidonkeydown
onkeydown:
| ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onkeydownonkeypress
onkeypress:
| ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)
| null;Defined in: typescript:
Deprecated
Inherited from
ReactiveElement.onkeypressonkeyup
onkeyup:
| ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onkeyuponload
onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onloadonloadeddata
onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onloadeddataonloadedmetadata
onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onloadedmetadataonloadstart
onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onloadstartonlostpointercapture
onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onlostpointercaptureonmousedown
onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmousedownonmouseenter
onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmouseenteronmouseleave
onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmouseleaveonmousemove
onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmousemoveonmouseout
onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmouseoutonmouseover
onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmouseoveronmouseup
onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onmouseuponpaste
onpaste:
| ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onpasteonpause
onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpauseonplay
onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onplayonplaying
onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onplayingonpointercancel
onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointercancelonpointerdown
onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointerdownonpointerenter
onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointerenteronpointerleave
onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointerleaveonpointermove
onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointermoveonpointerout
onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointeroutonpointerover
onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointeroveronpointerrawupdate
onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Available only in secure contexts.
Inherited from
ReactiveElement.onpointerrawupdateonpointerup
onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onpointeruponprogress
onprogress:
| ((this: GlobalEventHandlers, ev: ProgressEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onprogressonratechange
onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onratechangeonreset
onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onresetonresize
onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onresizeonscroll
onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onscrollonscrollend
onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onscrollendonsecuritypolicyviolation
onsecuritypolicyviolation:
| ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.onsecuritypolicyviolationonseeked
onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onseekedonseeking
onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onseekingonselect
onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onselectonselectionchange
onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onselectionchangeonselectstart
onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onselectstartonslotchange
onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onslotchangeonstalled
onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onstalledonsubmit
onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onsubmitonsuspend
onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onsuspendontimeupdate
ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontimeupdateontoggle
ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontoggleontouchcancel?
optional ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontouchcancelontouchend?
optional ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontouchendontouchmove?
optional ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontouchmoveontouchstart?
optional ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.ontouchstartontransitioncancel
ontransitioncancel:
| ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.ontransitioncancelontransitionend
ontransitionend:
| ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.ontransitionendontransitionrun
ontransitionrun:
| ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.ontransitionrunontransitionstart
ontransitionstart:
| ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
| null;Defined in: typescript:
Inherited from
ReactiveElement.ontransitionstartonvolumechange
onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onvolumechangeonwaiting
onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onwaitingonwebkitanimationend
onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Deprecated
This is a legacy alias of onanimationend.
Inherited from
ReactiveElement.onwebkitanimationendonwebkitanimationiteration
onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Deprecated
This is a legacy alias of onanimationiteration.
Inherited from
ReactiveElement.onwebkitanimationiterationonwebkitanimationstart
onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Deprecated
This is a legacy alias of onanimationstart.
Inherited from
ReactiveElement.onwebkitanimationstartonwebkittransitionend
onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;Defined in: typescript:
Deprecated
This is a legacy alias of ontransitionend.
Inherited from
ReactiveElement.onwebkittransitionendonwheel
onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;Defined in: typescript:
Inherited from
ReactiveElement.onwheelouterHTML
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.
Inherited from
ReactiveElement.outerHTMLouterText
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).
Inherited from
ReactiveElement.outerTextownerDocument
readonly ownerDocument: Document;Defined in: typescript:
The read-only ownerDocument property of the Node interface returns the top-level document object of the node.
Inherited from
ReactiveElement.ownerDocumentparentElement
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.
Inherited from
SignalWatcher.parentElement
parentNode
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.
Inherited from
SignalWatcher.parentNode
popover
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.
Inherited from
SignalWatcher.popover
prefix
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.
Inherited from
SignalWatcher.prefix
previousElementSibling
readonly previousElementSibling: Element | null;Defined in: typescript:
Returns the first preceding sibling that is an element, and null otherwise.
Inherited from
ReactiveElement.previousElementSiblingpreviousSibling
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.
Inherited from
SignalWatcher.previousSibling
PROCESSING_INSTRUCTION_NODE
readonly PROCESSING_INSTRUCTION_NODE: 7;Defined in: typescript:
node is a ProcessingInstruction node.
Inherited from
ReactiveElement.PROCESSING_INSTRUCTION_NODErole
role: string | null;Defined in: typescript:
Inherited from
ReactiveElement.rolescrollHeight
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.
Inherited from
ReactiveElement.scrollHeightscrollLeft
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.
Inherited from
ReactiveElement.scrollLeftscrollTop
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.
Inherited from
ReactiveElement.scrollTopscrollWidth
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.
Inherited from
ReactiveElement.scrollWidthshadowRoot
readonly shadowRoot: ShadowRoot | null;Defined in: typescript:
The Element.shadowRoot read-only property represents the shadow root hosted by the element.
Inherited from
SignalWatcher.shadowRoot
slot
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.
Inherited from
ReactiveElement.slotspellcheck
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.
Inherited from
ReactiveElement.spellchecktabIndex
tabIndex: number;Defined in: typescript:
Inherited from
ReactiveElement.tabIndextagName
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.
Inherited from
ReactiveElement.tagNameTEXT_NODE
readonly TEXT_NODE: 3;Defined in: typescript:
node is a Text node.
Inherited from
ReactiveElement.TEXT_NODEtitle
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.
Inherited from
ReactiveElement.titletranslate
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.
Inherited from
ReactiveElement.translatewritingSuggestions
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.
Inherited from
ReactiveElement.writingSuggestionsclassList
Get Signature
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.
Returns
DOMTokenList
Set Signature
set classList(value: string): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
Inherited from
ReactiveElement.classListpart
Get Signature
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.
Returns
DOMTokenList
Set Signature
set part(value: string): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
Inherited from
ReactiveElement.partstyle
Get Signature
get style(): CSSStyleDeclaration;Defined in: typescript:
Returns
CSSStyleDeclaration
Set Signature
set style(cssText: string): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
cssText | string |
Returns
void
Inherited from
ReactiveElement.styletextContent
Get Signature
get textContent(): string;Defined in: typescript:
Returns
string
Set Signature
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.
Parameters
| Parameter | Type |
|---|---|
value | string | null |
Returns
void
Inherited from
ReactiveElement.textContentaddEventListener()
Call Signature
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
| Parameter | Type |
|---|---|
type | K |
listener | (this: HTMLElement, ev: HTMLElementEventMap[K]) => any |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
ReactiveElement.addEventListenerCall Signature
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
ReactiveElement.addEventListenerafter()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.afteranimate()
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
keyframes | Keyframe[] | PropertyIndexedKeyframes | null |
options? | number | KeyframeAnimationOptions |
Returns
Animation
Inherited from
ReactiveElement.animateappend()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.appendappendChild()
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
Returns
T
Inherited from
ReactiveElement.appendChildattachInternals()
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.
Returns
ElementInternals
Inherited from
ReactiveElement.attachInternalsattachShadow()
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.
Parameters
| Parameter | Type |
|---|---|
init | ShadowRootInit |
Returns
ShadowRoot
Inherited from
ReactiveElement.attachShadowbefore()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.beforeblur()
blur(): void;Defined in: typescript:
Returns
void
Inherited from
ReactiveElement.blurcheckVisibility()
checkVisibility(options?: CheckVisibilityOptions): boolean;Defined in: typescript:
The checkVisibility() method of the Element interface checks whether the element is visible.
Parameters
| Parameter | Type |
|---|---|
options? | CheckVisibilityOptions |
Returns
boolean
Inherited from
ReactiveElement.checkVisibilityclick()
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).
Returns
void
Inherited from
ReactiveElement.clickcloneNode()
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.
Parameters
| Parameter | Type |
|---|---|
subtree? | boolean |
Returns
Node
Inherited from
ReactiveElement.cloneNodeclosest()
Call Signature
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
HTMLElementTagNameMap[K] | null
Inherited from
ReactiveElement.closestCall Signature
closest<K>(selector: K): SVGElementTagNameMap[K] | null;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
SVGElementTagNameMap[K] | null
Inherited from
ReactiveElement.closestCall Signature
closest<K>(selector: K): MathMLElementTagNameMap[K] | null;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
MathMLElementTagNameMap[K] | null
Inherited from
ReactiveElement.closestCall Signature
closest<E>(selectors: string): E | null;Defined in: typescript:
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
E | null
Inherited from
ReactiveElement.closestcompareDocumentPosition()
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.
Parameters
| Parameter | Type |
|---|---|
other | Node |
Returns
number
Inherited from
ReactiveElement.compareDocumentPositioncomputedStyleMap()
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.
Returns
StylePropertyMapReadOnly
Inherited from
ReactiveElement.computedStyleMapcontains()
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.
Parameters
| Parameter | Type |
|---|---|
other | Node | null |
Returns
boolean
Inherited from
ReactiveElement.containsdispatchEvent()
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().
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
ReactiveElement.dispatchEventfocus()
focus(options?: FocusOptions): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
options? | FocusOptions |
Returns
void
Inherited from
ReactiveElement.focusgetAnimations()
getAnimations(options?: GetAnimationsOptions): Animation[];Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
options? | GetAnimationsOptions |
Returns
Animation[]
Inherited from
ReactiveElement.getAnimationsgetAttribute()
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
string | null
Inherited from
ReactiveElement.getAttributegetAttributeNames()
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.
Returns
string[]
Inherited from
ReactiveElement.getAttributeNamesgetAttributeNode()
getAttributeNode(qualifiedName: string): Attr | null;Defined in: typescript:
Returns the specified attribute of the specified element, as an Attr node.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
Attr | null
Inherited from
ReactiveElement.getAttributeNodegetAttributeNodeNS()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
Attr | null
Inherited from
ReactiveElement.getAttributeNodeNSgetAttributeNS()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
string | null
Inherited from
ReactiveElement.getAttributeNSgetBoundingClientRect()
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.
Returns
DOMRect
Inherited from
ReactiveElement.getBoundingClientRectgetClientRects()
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.
Returns
DOMRectList
Inherited from
ReactiveElement.getClientRectsgetElementsByClassName()
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.
Parameters
| Parameter | Type |
|---|---|
classNames | string |
Returns
HTMLCollectionOf<Element>
Inherited from
ReactiveElement.getElementsByClassNamegetElementsByTagName()
Call Signature
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from
ReactiveElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from
ReactiveElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from
ReactiveElement.getElementsByTagNameCall Signature
getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementDeprecatedTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
ReactiveElement.getElementsByTagNameCall Signature
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
HTMLCollectionOf<Element>
Inherited from
ReactiveElement.getElementsByTagNamegetElementsByTagNameNS()
Call Signature
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.
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/1999/xhtml" |
localName | string |
Returns
HTMLCollectionOf<HTMLElement>
Inherited from
ReactiveElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/2000/svg" |
localName | string |
Returns
HTMLCollectionOf<SVGElement>
Inherited from
ReactiveElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/1998/Math/MathML" |
localName | string |
Returns
HTMLCollectionOf<MathMLElement>
Inherited from
ReactiveElement.getElementsByTagNameNSCall Signature
getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
HTMLCollectionOf<Element>
Inherited from
ReactiveElement.getElementsByTagNameNSgetHTML()
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.
Parameters
| Parameter | Type |
|---|---|
options? | GetHTMLOptions |
Returns
string
Inherited from
ReactiveElement.getHTMLgetRootNode()
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.
Parameters
| Parameter | Type |
|---|---|
options? | GetRootNodeOptions |
Returns
Node
Inherited from
ReactiveElement.getRootNodehasAttribute()
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
boolean
Inherited from
ReactiveElement.hasAttributehasAttributeNS()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
boolean
Inherited from
ReactiveElement.hasAttributeNShasAttributes()
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.
Returns
boolean
Inherited from
ReactiveElement.hasAttributeshasChildNodes()
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.
Returns
boolean
Inherited from
ReactiveElement.hasChildNodeshasPointerCapture()
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.
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
Returns
boolean
Inherited from
ReactiveElement.hasPointerCapturehidePopover()
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.
Returns
void
Inherited from
ReactiveElement.hidePopoverinsertAdjacentElement()
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.
Parameters
| Parameter | Type |
|---|---|
where | InsertPosition |
element | Element |
Returns
Element | null
Inherited from
ReactiveElement.insertAdjacentElementinsertAdjacentHTML()
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.
Parameters
| Parameter | Type |
|---|---|
position | InsertPosition |
string | string |
Returns
void
Inherited from
ReactiveElement.insertAdjacentHTMLinsertAdjacentText()
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.
Parameters
| Parameter | Type |
|---|---|
where | InsertPosition |
data | string |
Returns
void
Inherited from
ReactiveElement.insertAdjacentTextinsertBefore()
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
child | Node | null |
Returns
T
Inherited from
ReactiveElement.insertBeforeisDefaultNamespace()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
Returns
boolean
Inherited from
ReactiveElement.isDefaultNamespaceisEqualNode()
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.
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | null |
Returns
boolean
Inherited from
ReactiveElement.isEqualNodeisSameNode()
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).
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | null |
Returns
boolean
Inherited from
ReactiveElement.isSameNodelookupNamespaceURI()
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().
Parameters
| Parameter | Type |
|---|---|
prefix | string | null |
Returns
string | null
Inherited from
ReactiveElement.lookupNamespaceURIlookupPrefix()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
Returns
string | null
Inherited from
ReactiveElement.lookupPrefixmatches()
Call Signature
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
this is HTMLElementTagNameMap[K]
Inherited from
ReactiveElement.matchesCall Signature
matches<K>(selectors: K): this is SVGElementTagNameMap[K];Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
this is SVGElementTagNameMap[K]
Inherited from
ReactiveElement.matchesCall Signature
matches<K>(selectors: K): this is MathMLElementTagNameMap[K];Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
this is MathMLElementTagNameMap[K]
Inherited from
ReactiveElement.matchesCall Signature
matches(selectors: string): boolean;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
boolean
Inherited from
ReactiveElement.matchesmoveBefore()
moveBefore(node: Node, child: Node | null): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
node | Node |
child | Node | null |
Returns
void
Inherited from
ReactiveElement.moveBeforenormalize()
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.
Returns
void
Inherited from
ReactiveElement.normalizeprepend()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.prependquerySelector()
Call Signature
querySelector<K>(selectors: K): HTMLElementTagNameMap[K] | null;Defined in: typescript:
Returns the first element that is a descendant of node that matches selectors.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
HTMLElementTagNameMap[K] | null
Inherited from
ReactiveElement.querySelectorCall Signature
querySelector<K>(selectors: K): SVGElementTagNameMap[K] | null;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
SVGElementTagNameMap[K] | null
Inherited from
ReactiveElement.querySelectorCall Signature
querySelector<K>(selectors: K): MathMLElementTagNameMap[K] | null;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
MathMLElementTagNameMap[K] | null
Inherited from
ReactiveElement.querySelectorCall Signature
querySelector<K>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementDeprecatedTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
HTMLElementDeprecatedTagNameMap[K] | null
Deprecated
Inherited from
ReactiveElement.querySelectorCall Signature
querySelector<E>(selectors: string): E | null;Defined in: typescript:
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
E | null
Inherited from
ReactiveElement.querySelectorquerySelectorAll()
Call Signature
querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;Defined in: typescript:
Returns all element descendants of node that match selectors.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
NodeListOf<HTMLElementTagNameMap[K]>
Inherited from
ReactiveElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
NodeListOf<SVGElementTagNameMap[K]>
Inherited from
ReactiveElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
NodeListOf<MathMLElementTagNameMap[K]>
Inherited from
ReactiveElement.querySelectorAllCall Signature
querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;Defined in: typescript:
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementDeprecatedTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
Returns
NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
ReactiveElement.querySelectorAllCall Signature
querySelectorAll<E>(selectors: string): NodeListOf<E>;Defined in: typescript:
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
NodeListOf<E>
Inherited from
ReactiveElement.querySelectorAllreleasePointerCapture()
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.
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
Returns
void
Inherited from
ReactiveElement.releasePointerCaptureremove()
remove(): void;Defined in: typescript:
Removes node.
Returns
void
Inherited from
ReactiveElement.removeremoveAttribute()
removeAttribute(qualifiedName: string): void;Defined in: typescript:
The Element method removeAttribute() removes the attribute with the specified name from the element.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
void
Inherited from
ReactiveElement.removeAttributeremoveAttributeNode()
removeAttributeNode(attr: Attr): Attr;Defined in: typescript:
The removeAttributeNode() method of the Element interface removes the specified Attr node from the element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
Returns
Attr
Inherited from
ReactiveElement.removeAttributeNoderemoveAttributeNS()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
void
Inherited from
ReactiveElement.removeAttributeNSremoveChild()
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
child | T |
Returns
T
Inherited from
ReactiveElement.removeChildremoveEventListener()
Call Signature
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
| Parameter | Type |
|---|---|
type | K |
listener | (this: HTMLElement, ev: HTMLElementEventMap[K]) => any |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
ReactiveElement.removeEventListenerCall Signature
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
ReactiveElement.removeEventListenerreplaceChild()
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | Node |
child | T |
Returns
T
Inherited from
ReactiveElement.replaceChildreplaceChildren()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.replaceChildrenreplaceWith()
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ReactiveElement.replaceWithrequestFullscreen()
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.
Parameters
| Parameter | Type |
|---|---|
options? | FullscreenOptions |
Returns
Promise<void>
Inherited from
ReactiveElement.requestFullscreenrequestPointerLock()
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.
Parameters
| Parameter | Type |
|---|---|
options? | PointerLockOptions |
Returns
Promise<void>
Inherited from
ReactiveElement.requestPointerLockscroll()
Call Signature
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.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Inherited from
ReactiveElement.scrollCall Signature
scroll(x: number, y: number): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
Inherited from
ReactiveElement.scrollscrollBy()
Call Signature
scrollBy(options?: ScrollToOptions): void;Defined in: typescript:
The scrollBy() method of the Element interface scrolls an element by the given amount.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Inherited from
ReactiveElement.scrollByCall Signature
scrollBy(x: number, y: number): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
Inherited from
ReactiveElement.scrollByscrollIntoView()
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.
Parameters
| Parameter | Type |
|---|---|
arg? | boolean | ScrollIntoViewOptions |
Returns
void
Inherited from
ReactiveElement.scrollIntoViewscrollTo()
Call Signature
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.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Inherited from
ReactiveElement.scrollToCall Signature
scrollTo(x: number, y: number): void;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
Inherited from
ReactiveElement.scrollTosetAttribute()
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
value | string |
Returns
void
Inherited from
ReactiveElement.setAttributesetAttributeNode()
setAttributeNode(attr: Attr): Attr | null;Defined in: typescript:
The setAttributeNode() method of the Element interface adds a new Attr node to the specified element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
Returns
Attr | null
Inherited from
ReactiveElement.setAttributeNodesetAttributeNodeNS()
setAttributeNodeNS(attr: Attr): Attr | null;Defined in: typescript:
The setAttributeNodeNS() method of the Element interface adds a new namespaced Attr node to an element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
Returns
Attr | null
Inherited from
ReactiveElement.setAttributeNodeNSsetAttributeNS()
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
qualifiedName | string |
value | string |
Returns
void
Inherited from
ReactiveElement.setAttributeNSsetHTMLUnsafe()
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.
Parameters
| Parameter | Type |
|---|---|
html | string |
Returns
void
Inherited from
ReactiveElement.setHTMLUnsafesetPointerCapture()
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).
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
Returns
void
Inherited from
ReactiveElement.setPointerCaptureshowPopover()
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.
Parameters
| Parameter | Type |
|---|---|
options? | ShowPopoverOptions |
Returns
void
Inherited from
ReactiveElement.showPopovertoggleAttribute()
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
force? | boolean |
Returns
boolean
Inherited from
ReactiveElement.toggleAttributetogglePopover()
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.
Parameters
| Parameter | Type |
|---|---|
options? | boolean | TogglePopoverOptions |
Returns
boolean
Inherited from
ReactiveElement.togglePopoverwebkitMatchesSelector()
webkitMatchesSelector(selectors: string): boolean;Defined in: typescript:
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
boolean
Deprecated
This is a legacy alias of matches.
Inherited from
ReactiveElement.webkitMatchesSelectorattributes
attributeChangedCallback()
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
| Parameter | Type |
|---|---|
name | string |
_old | string | null |
value | string | null |
Returns
void
Inherited from
ReactiveElement.attributeChangedCallbackcontrollers
addController()
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
| Parameter | Type |
|---|---|
controller | ReactiveController |
Returns
void
Inherited from
ReactiveElement.addControllerremoveController()
removeController(controller: ReactiveController): void;Defined in: @lit/reactive-element:
Removes a ReactiveController from the element.
Parameters
| Parameter | Type |
|---|---|
controller | ReactiveController |
Returns
void
Inherited from
ReactiveElement.removeControllerlifecycle
connectedCallback()
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
ReactiveElement.connectedCallbackdisconnectedCallback()
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
ReactiveElement.disconnectedCallbackrendering
renderRoot
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()
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
ReactiveElement.createRenderRootupdates
hasUpdated
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
ReactiveElement.hasUpdatedisUpdatePending
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
ReactiveElement.isUpdatePendingupdateComplete
Get Signature
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
ReactiveElement.updateCompleteenableUpdating()
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
| Parameter | Type |
|---|---|
_requestedUpdate | boolean |
Returns
void
Inherited from
ReactiveElement.enableUpdatingfirstUpdated()
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.
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
| Parameter | Type | Description |
|---|---|---|
_changedProperties | PropertyValueMap<any> | Map<PropertyKey, unknown> | Map of changed properties with old values |
Returns
void
Inherited from
ReactiveElement.firstUpdatedgetUpdateComplete()
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:
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
ReactiveElement.getUpdateCompleteperformUpdate()
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
ReactiveElement.performUpdaterequestUpdate()
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
| Parameter | Type | Description |
|---|---|---|
name? | PropertyKey | name of requesting property |
oldValue? | unknown | old value of requesting property |
options? | PropertyDeclaration<unknown, unknown> | property options to use instead of the previously configured options |
useNewValue? | boolean | if 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? | unknown | the new value of the property. This is only used if useNewValue is true. |
Returns
void
Inherited from
ReactiveElement.requestUpdatescheduleUpdate()
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:
override protected async scheduleUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.scheduleUpdate();
}Returns
void | Promise<unknown>
Inherited from
ReactiveElement.scheduleUpdateshouldUpdate()
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
| Parameter | Type | Description |
|---|---|---|
_changedProperties | PropertyValueMap<any> | Map<PropertyKey, unknown> | Map of changed properties with old values |
Returns
boolean
Inherited from
ReactiveElement.shouldUpdateupdate()
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
| Parameter | Type | Description |
|---|---|---|
_changedProperties | PropertyValueMap<any> | Map<PropertyKey, unknown> | Map of changed properties with old values |
Returns
void
Inherited from
ReactiveElement.updateupdated()
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
| Parameter | Type | Description |
|---|---|---|
_changedProperties | PropertyValueMap<any> | Map<PropertyKey, unknown> | Map of changed properties with old values |
Returns
void
Inherited from
ReactiveElement.updatedwillUpdate()
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.
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
| Parameter | Type |
|---|---|
_changedProperties | PropertyValueMap<any> | Map<PropertyKey, unknown> |
Returns
void
Inherited from
ReactiveElement.willUpdate