Hierarchy

Constructors

Properties - Other

ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE PROCESSING_INSTRUCTION_NODE TEXT_NODE accessKey accessKeyLabel ariaAtomic ariaAutoComplete ariaBusy ariaChecked ariaColCount ariaColIndex ariaColSpan ariaCurrent ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot attributeStyleMap attributes autocapitalize autofocus baseURI childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth contentEditable dataset dir draggable enterKeyHint firstChild firstElementChild hidden icon? id inert innerHTML innerText inputMode isConnected isContentEditable lang lastChild lastElementChild localName message? namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText ownerDocument parentElement parentNode part prefix previousElementSibling previousSibling role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot spellcheck style tabIndex tagName textContent title translate type? [metadata] _$litElement$ _initializers? finalized

Properties - dev-mode

Properties - properties

Properties - rendering

Properties - styles

Properties - updates

Accessors - attributes

Accessors - updates

Methods - Other

Methods - attributes

Methods - controllers

Methods - lifecycle

Methods - properties

Methods - rendering

Methods - styles

Methods - updates

Constructors

Properties - Other

ATTRIBUTE_NODE: 2
CDATA_SECTION_NODE: 4

node is a CDATASection node.

COMMENT_NODE: 8

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

DOCUMENT_NODE: 9

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: 1

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

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

DOCUMENT_TYPE_NODE: 10

node is a doctype.

ELEMENT_NODE: 1

node is an element.

ENTITY_NODE: 6
ENTITY_REFERENCE_NODE: 5
NOTATION_NODE: 12
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

TEXT_NODE: 3

node is a Text node.

accessKey: string
accessKeyLabel: string
ariaAtomic: string
ariaAutoComplete: string
ariaBusy: string
ariaChecked: string
ariaColCount: string
ariaColIndex: string
ariaColSpan: string
ariaCurrent: string
ariaDisabled: string
ariaExpanded: string
ariaHasPopup: string
ariaHidden: string
ariaInvalid: string
ariaKeyShortcuts: string
ariaLabel: string
ariaLevel: string
ariaLive: string
ariaModal: string
ariaMultiLine: string
ariaMultiSelectable: string
ariaOrientation: string
ariaPlaceholder: string
ariaPosInSet: string
ariaPressed: string
ariaReadOnly: string
ariaRequired: string
ariaRoleDescription: string
ariaRowCount: string
ariaRowIndex: string
ariaRowSpan: string
ariaSelected: string
ariaSetSize: string
ariaSort: string
ariaValueMax: string
ariaValueMin: string
ariaValueNow: string
ariaValueText: string
assignedSlot: HTMLSlotElement
attributeStyleMap: StylePropertyMap
attributes: NamedNodeMap
autocapitalize: string
autofocus: boolean
baseURI: string

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

MDN Reference

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

children: HTMLCollection

Returns the child elements.

MDN Reference

classList: DOMTokenList

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

MDN Reference

className: string

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

MDN Reference

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
contentEditable: string
dataset: DOMStringMap
dir: string
draggable: boolean
enterKeyHint: string
firstChild: ChildNode

Returns the first child.

MDN Reference

firstElementChild: Element

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

MDN Reference

hidden: boolean
icon?: string
id: string

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

MDN Reference

inert: boolean
innerHTML: string
innerText: string
inputMode: string
isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

isContentEditable: boolean
lang: string
lastChild: ChildNode

Returns the last child.

MDN Reference

lastElementChild: Element

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

MDN Reference

localName: string

Returns the local name.

MDN Reference

message?: string
namespaceURI: string

Returns the namespace.

MDN Reference

nextElementSibling: Element

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

MDN Reference

nextSibling: ChildNode

Returns the next sibling.

MDN Reference

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

nodeType: number

Returns the type of node.

MDN Reference

nodeValue: string
nonce?: string
offsetHeight: number
offsetLeft: number
offsetParent: Element
offsetTop: number
offsetWidth: number
onabort: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user aborts the download.

      Parameters

      Returns any

onanimationcancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

onauxclick: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onbeforeinput: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

onblur: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the object loses the input focus.

      Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The focus event.

        MDN Reference

      Returns any

oncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncanplay: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when playback is possible, but would require further buffering.

      Parameters

      Returns any

oncanplaythrough: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the contents of the object or selection have changed.

      Parameters

      Returns any

onclick: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user clicks the left mouse button on the object

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onclose: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncontextmenu: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user clicks the right mouse button in the client area, opening the context menu.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

oncopy: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

oncuechange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oncut: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

ondblclick: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user double-clicks the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

ondrag: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the source object continuously during a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

        MDN Reference

      Returns any

ondragend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the source object when the user releases the mouse at the close of a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

        MDN Reference

      Returns any

ondragenter: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the target element when the user drags the object to a valid drop target.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragleave: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The drag event.

        MDN Reference

      Returns any

ondragover: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the target element continuously while the user drags the object over a valid drop target.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

        MDN Reference

      Returns any

ondragstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires on the source object when the user starts to drag a text selection or selected object.

      Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

        The event.

        MDN Reference

      Returns any

ondrop: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

ondurationchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the duration attribute is updated.

      Parameters

      Returns any

onemptied: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the media element is reset to its initial state.

      Parameters

      Returns any

onended: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the end of playback is reached.

      Parameters

      Returns any

onerror: OnErrorEventHandlerNonNull

Fires when an error occurs during object loading.

Param

The event.

MDN Reference

onfocus: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the object receives focus.

      Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

        The event.

        MDN Reference

      Returns any

onformdata: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

onfullscreenchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

onfullscreenerror: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: Element
      • ev: Event

      Returns any

ongotpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

oninput: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

oninvalid: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onkeydown: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user presses a key.

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onkeypress: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user presses an alphanumeric key.

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The event.

      Returns any

      Deprecated

      MDN Reference

onkeyup: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user releases a key.

      Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

        The keyboard event

        MDN Reference

      Returns any

onload: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires immediately after the browser loads the object.

      Parameters

      Returns any

onloadeddata: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when media data is loaded at the current playback position.

      Parameters

      Returns any

onloadedmetadata: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the duration and dimensions of the media have been determined.

      Parameters

      Returns any

onloadstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when Internet Explorer begins looking for media data.

      Parameters

      Returns any

onlostpointercapture: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onmousedown: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user clicks the object with either mouse button.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseenter: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmouseleave: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

onmousemove: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse over the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseout: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse pointer outside the boundaries of the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseover: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user moves the mouse pointer into the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onmouseup: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user releases a mouse button while the mouse is over the object.

      Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

        The mouse event.

        MDN Reference

      Returns any

onpaste: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

onpause: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when playback is paused.

      Parameters

      Returns any

onplay: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the play method is requested.

      Parameters

      Returns any

onplaying: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the audio or video has started playing.

      Parameters

      Returns any

onpointercancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerdown: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerenter: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerleave: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointermove: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerout: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerover: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onpointerup: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

onprogress: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs to indicate progress while downloading media data.

      Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

        The event.

        MDN Reference

      Returns any

onratechange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the playback rate is increased or decreased.

      Parameters

      Returns any

onreset: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user resets a form.

      Parameters

      Returns any

onresize: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

onscroll: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the user repositions the scroll box in the scroll bar on the object.

      Parameters

      Returns any

onsecuritypolicyviolation: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

onseeked: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the seek operation ends.

      Parameters

      Returns any

onseeking: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the current playback position is moved.

      Parameters

      Returns any

onselect: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Fires when the current selection changes.

      Parameters

      Returns any

onselectionchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onselectstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onslotchange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

onstalled: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the download has stopped.

      Parameters

      Returns any

onsubmit: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

onsuspend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs if the load operation has been intentionally halted.

      Parameters

      Returns any

ontimeupdate: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs to indicate the current playback position.

      Parameters

      Returns any

ontoggle: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

ontouchcancel?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchend?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchmove?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontouchstart?: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

ontransitioncancel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionrun: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

ontransitionstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

onvolumechange: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when the volume is changed, or playback is muted or unmuted.

      Parameters

      Returns any

onwaiting: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Occurs when playback stops because the next frame of a video resource is not available.

      Parameters

      Returns any

onwebkitanimationend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

      Deprecated

      This is a legacy alias of onanimationend.

      MDN Reference

onwebkitanimationiteration: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

      Deprecated

      This is a legacy alias of onanimationiteration.

      MDN Reference

onwebkitanimationstart: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

      Deprecated

      This is a legacy alias of onanimationstart.

      MDN Reference

onwebkittransitionend: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

      Deprecated

      This is a legacy alias of ontransitionend.

      MDN Reference

onwheel: ((this, ev) => any)

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

outerHTML: string
outerText: string
ownerDocument: Document
parentElement: HTMLElement

Returns the parent element.

MDN Reference

parentNode: ParentNode

Returns the parent.

MDN Reference

part: DOMTokenList
prefix: string

Returns the namespace prefix.

MDN Reference

previousElementSibling: Element

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

MDN Reference

previousSibling: ChildNode

Returns the previous sibling.

MDN Reference

role: string
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

slot: string

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

MDN Reference

spellcheck: boolean
style: CSSStyleDeclaration
tabIndex: number
tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

textContent: string
title: string
translate: boolean
[metadata]: object & Record<PropertyKey, unknown>
_$litElement$: boolean
_initializers?: Initializer[]
finalized: true

Marks class as having been finalized, which includes creating properties from static properties, but does not include all properties created from decorators.

Nocollapse

Properties - dev-mode

disableWarning?: ((warningKind) => void)

Type declaration

    • (warningKind): void
    • Disable the given warning category for this class.

      This method only exists in development builds, so it should be accessed with a guard like:

      // Disable for all ReactiveElement subclasses
      ReactiveElement.disableWarning?.('migration');

      // Disable for only MyElement and subclasses
      MyElement.disableWarning?.('migration');

      Parameters

      • warningKind: WarningKind

      Returns void

      Nocollapse

enableWarning?: ((warningKind) => void)

Type declaration

    • (warningKind): void
    • Enable the given warning category for this class.

      This method only exists in development builds, so it should be accessed with a guard like:

      // Enable for all ReactiveElement subclasses
      ReactiveElement.enableWarning?.('migration');

      // Enable for only MyElement and subclasses
      MyElement.enableWarning?.('migration');

      Parameters

      • warningKind: WarningKind

      Returns void

      Nocollapse

enabledWarnings?: WarningKind[]

Read or set all the enabled warning categories for this class.

This property is only used in development builds.

Nocollapse

Properties - properties

elementProperties: PropertyDeclarationMap

Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.

Nocollapse

properties: PropertyDeclarations

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

Nocollapse

Properties - rendering

renderOptions: RenderOptions
renderRoot: HTMLElement | DocumentFragment

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

shadowRootOptions: ShadowRootInit

Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

Nocollapse

Properties - styles

elementStyles: CSSResultOrNative[]

Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.

Nocollapse

styles?: CSSResultGroup

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>

Nocollapse

Properties - updates

hasUpdated: boolean

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

isUpdatePending: boolean

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

Accessors - attributes

  • get observedAttributes(): string[]
  • Returns a list of attributes corresponding to the registered properties.

    Returns string[]

    Nocollapse

Accessors - updates

  • get updateComplete(): Promise<boolean>
  • 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.

Methods - Other

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Parameters

    • keyframes: Keyframe[] | PropertyIndexedKeyframes
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

  • Returns ElementInternals

  • Creates a shadow root for element and returns it.

    MDN Reference

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Returns void

  • Parameters

    • Optional options: CheckVisibilityOptions

    Returns boolean

  • Returns void

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

    MDN Reference

    Parameters

    • Optional deep: boolean

    Returns Node

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

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns MathMLElementTagNameMap[K]

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

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

    MDN Reference

    Parameters

    • other: Node

    Returns number

  • Returns StylePropertyMapReadOnly

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

    MDN Reference

    Parameters

    • other: Node

    Returns boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

  • Parameters

    • Optional options: FocusOptions

    Returns void

  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns string

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

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns string

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

    MDN Reference

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns Attr

  • Parameters

    • namespace: string
    • localName: string

    Returns Attr

  • Returns DOMRect

  • Returns DOMRectList

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Returns node's root.

    MDN Reference

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

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

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns boolean

  • Returns true if element has attributes, and false otherwise.

    MDN Reference

    Returns boolean

  • Returns whether node has children.

    MDN Reference

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns Element

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

  • Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: Node

    Returns T

  • Parameters

    • namespace: string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • otherNode: Node

    Returns boolean

  • Parameters

    • prefix: string

    Returns string

  • Parameters

    • namespace: string

    Returns string

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

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    MDN Reference

    Returns void

  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

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

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns HTMLElementDeprecatedTagNameMap[K]

    Deprecated

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns E

  • Returns all element descendants of node that match selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

  • Parameters

    • pointerId: number

    Returns void

  • Removes node.

    MDN Reference

    Returns void

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

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

    MDN Reference

    Parameters

    • namespace: string
    • localName: string

    Returns void

  • Parameters

    • attr: Attr

    Returns Attr

  • Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

  • Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

  • Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    MDN Reference

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

  • Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

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

    MDN Reference

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

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

    MDN Reference

    Parameters

    • namespace: string
    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • attr: Attr

    Returns Attr

  • Parameters

    • pointerId: number

    Returns void

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

  • Adds an initializer function to the class that is called during instance construction.

    This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.

    const myDecorator = (target: typeof ReactiveElement, key: string) => {
    target.addInitializer((instance: ReactiveElement) => {
    // This is run during construction of the element
    new MyController(instance);
    });
    }

    Decorating a field will then cause each instance to run an initializer that adds a controller:

    class MyElement extends LitElement {
    @myDecorator foo;
    }

    Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.

    Parameters

    • initializer: Initializer

    Returns void

    Nocollapse

  • Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.

    This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.

    Returns void

    Nocollapse

Methods - attributes

  • 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 using the lifecycle callbacks on MDN for more information about the attributeChangedCallback.

    Parameters

    • name: string
    • _old: string
    • value: string

    Returns void

Methods - controllers

  • 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

    • controller: ReactiveController

    Returns void

  • Removes a ReactiveController from the element.

    Parameters

    • controller: ReactiveController

    Returns void

Methods - lifecycle

  • Invoked when the component is added to the document's DOM.

    In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

    connectedCallback() {
    super.connectedCallback();
    addEventListener('keydown', this._handleKeydown);
    }

    Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

    Returns void

  • Invoked when the component is removed from the document's DOM.

    This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

    disconnectedCallback() {
    super.disconnectedCallback();
    window.removeEventListener('keydown', this._handleKeydown);
    }

    An element may be re-connected after being disconnected.

    Returns void

Methods - properties

  • Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.

    This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:

    static createProperty(name, options) {
    options = Object.assign(options, {myOption: true});
    super.createProperty(name, options);
    }

    Parameters

    • name: PropertyKey
    • Optional options: PropertyDeclaration<unknown, unknown>

    Returns void

    Nocollapse

  • Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,

    class MyElement extends LitElement {
    static getPropertyDescriptor(name, key, options) {
    const defaultDescriptor =
    super.getPropertyDescriptor(name, key, options);
    const setter = defaultDescriptor.set;
    return {
    get: defaultDescriptor.get,
    set(value) {
    setter.call(this, value);
    // custom action.
    },
    configurable: true,
    enumerable: true
    }
    }
    }

    Parameters

    • name: PropertyKey
    • key: string | symbol
    • options: PropertyDeclaration<unknown, unknown>

    Returns PropertyDescriptor

    Nocollapse

  • Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).

    Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.

    Parameters

    • name: PropertyKey

    Returns PropertyDeclaration<unknown, unknown>

    Nocollapse

    Final

Methods - rendering

  • Returns HTMLElement | DocumentFragment

Methods - styles

  • Takes the styles the user supplied via the static styles property and returns the array of styles to apply to the element. Override this method to integrate into a style management system.

    Styles are deduplicated preserving the last instance in the list. This is a performance optimization to avoid duplicated styles that can occur especially when composing via subclassing. The last item is kept to try to preserve the cascade order with the assumption that it's most important that last added styles override previous styles.

    Parameters

    • Optional styles: CSSResultGroup

    Returns CSSResultOrNative[]

    Nocollapse

Methods - updates

  • 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

    • _requestedUpdate: boolean

    Returns void

  • 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

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns void

  • 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.

  • 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

  • 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

    • Optional name: PropertyKey

      name of requesting property

    • Optional oldValue: unknown

      old value of requesting property

    • Optional options: PropertyDeclaration<unknown, unknown>

      property options to use instead of the previously configured options

    Returns void

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

  • 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

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns boolean

  • Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.

    Parameters

    • changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns void

  • 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

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

      Map of changed properties with old values

    Returns void

  • 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

    • _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>

    Returns void

Generated using TypeDoc