Class UmbInputMediaElement

Hierarchy

Other

constructor

ReadonlyATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

ReadonlyCDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

ReadonlyCOMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

ReadonlyDOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

ReadonlyDOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

ReadonlyDOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

ReadonlyDOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

ReadonlyDOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

ReadonlyDOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

ReadonlyDOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

ReadonlyELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

ReadonlyENTITY_NODE

ENTITY_NODE: 6

ReadonlyENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

ReadonlyNOTATION_NODE

NOTATION_NODE: 12

ReadonlyPROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

ReadonlyTEXT_NODE

TEXT_NODE: 3

node is a Text node.

Protected_internals

_internals: ElementInternals

accessKey

accessKey: string

MDN Reference

ReadonlyaccessKeyLabel

accessKeyLabel: string

MDN Reference

addValidator

addValidator: ((flagKey: FlagTypes, getMessageMethod: (() => string), checkMethod: (() => boolean)) => UmbFormControlValidatorConfig)

OptionalallowedContentTypeIds

allowedContentTypeIds?: string[]

ariaAtomic

ariaAtomic: null | string

MDN Reference

ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

ariaBrailleLabel

ariaBrailleLabel: null | string

ariaBrailleRoleDescription

ariaBrailleRoleDescription: null | string

ariaBusy

ariaBusy: null | string

MDN Reference

ariaChecked

ariaChecked: null | string

MDN Reference

ariaColCount

ariaColCount: null | string

MDN Reference

ariaColIndex

ariaColIndex: null | string

MDN Reference

ariaColSpan

ariaColSpan: null | string

MDN Reference

ariaCurrent

ariaCurrent: null | string

MDN Reference

ariaDescription

ariaDescription: null | string

MDN Reference

ariaDisabled

ariaDisabled: null | string

MDN Reference

ariaExpanded

ariaExpanded: null | string

MDN Reference

ariaHasPopup

ariaHasPopup: null | string

MDN Reference

ariaHidden

ariaHidden: null | string

MDN Reference

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

ariaLabel

ariaLabel: null | string

MDN Reference

ariaLevel

ariaLevel: null | string

MDN Reference

ariaLive

ariaLive: null | string

MDN Reference

ariaModal

ariaModal: null | string

MDN Reference

ariaMultiLine

ariaMultiLine: null | string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

ariaOrientation

ariaOrientation: null | string

MDN Reference

ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

ariaPosInSet

ariaPosInSet: null | string

MDN Reference

ariaPressed

ariaPressed: null | string

MDN Reference

ariaReadOnly

ariaReadOnly: null | string

MDN Reference

ariaRequired

ariaRequired: null | string

MDN Reference

ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

ariaRowCount

ariaRowCount: null | string

MDN Reference

ariaRowIndex

ariaRowIndex: null | string

MDN Reference

ariaRowSpan

ariaRowSpan: null | string

MDN Reference

ariaSelected

ariaSelected: null | string

MDN Reference

ariaSetSize

ariaSetSize: null | string

MDN Reference

ariaSort

ariaSort: null | string

MDN Reference

ariaValueMax

ariaValueMax: null | string

MDN Reference

ariaValueMin

ariaValueMin: null | string

MDN Reference

ariaValueNow

ariaValueNow: null | string

MDN Reference

ariaValueText

ariaValueText: null | string

MDN Reference

ReadonlyassignedSlot

assignedSlot: null | HTMLSlotElement

MDN Reference

ReadonlyattributeStyleMap

attributeStyleMap: StylePropertyMap

Readonlyattributes

attributes: NamedNodeMap

MDN Reference

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

MDN Reference

ReadonlybaseURI

baseURI: string

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

MDN Reference

ReadonlychildElementCount

childElementCount: number

MDN Reference

ReadonlychildNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

Readonlychildren

children: HTMLCollection

Returns the child elements.

MDN Reference

ReadonlyclassList

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

className: string

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

MDN Reference

ReadonlyclientHeight

clientHeight: number

MDN Reference

ReadonlyclientLeft

clientLeft: number

MDN Reference

ReadonlyclientTop

clientTop: number

MDN Reference

ReadonlyclientWidth

clientWidth: number

MDN Reference

contentEditable

contentEditable: string

MDN Reference

Readonlydataset

dataset: DOMStringMap

MDN Reference

dir

dir: "" | "ltr" | "rtl"

MDN Reference

draggable

draggable: boolean

MDN Reference

enterKeyHint

enterKeyHint: string

MDN Reference

ReadonlyfirstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

ReadonlyfirstElementChild

firstElementChild: null | Element

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

MDN Reference

hidden

hidden: boolean

MDN Reference

id

id: string

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

MDN Reference

inert

inert: boolean

MDN Reference

innerHTML

innerHTML: string

MDN Reference

innerText

innerText: string

MDN Reference

inputMode

inputMode: string

MDN Reference

ReadonlyisConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

ReadonlyisContentEditable

isContentEditable: boolean

MDN Reference

lang

lang: string

MDN Reference

ReadonlylastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

ReadonlylastElementChild

lastElementChild: null | Element

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

MDN Reference

ReadonlylocalName

localName: string

Returns the local name.

MDN Reference

localize

localize: UmbLocalizationController<UmbLocalizationSet>

Use the UmbLocalizeController to localize your element.

See

UmbLocalizationController

maxMessage

maxMessage: string = 'This field exceeds the allowed amount of items'

Max validation message.

Attr

Default

minMessage

minMessage: string = 'This field need more items'

Min validation message.

Attr

Default

ReadonlynamespaceURI

namespaceURI: null | string

Returns the namespace.

MDN Reference

ReadonlynextElementSibling

nextElementSibling: null | Element

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

MDN Reference

ReadonlynextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

ReadonlynodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

ReadonlynodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

Optionalnonce

nonce?: string

MDN Reference

ReadonlyoffsetHeight

offsetHeight: number

MDN Reference

ReadonlyoffsetLeft

offsetLeft: number

MDN Reference

ReadonlyoffsetParent

offsetParent: null | Element

MDN Reference

ReadonlyoffsetTop

offsetTop: number

MDN Reference

ReadonlyoffsetWidth

offsetWidth: number

MDN Reference

onabort

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

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onanimationcancel

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

MDN Reference

onanimationend

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

MDN Reference

onanimationiteration

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

MDN Reference

onanimationstart

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

MDN Reference

onauxclick

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

MDN Reference

onbeforeinput

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

MDN Reference

onbeforetoggle

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

MDN Reference

onblur

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

Fires when the object loses the input focus.

Param: ev

The focus event.

MDN Reference

oncancel

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

MDN Reference

oncanplay

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

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

Param: ev

The event.

MDN Reference

oncanplaythrough

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

MDN Reference

onchange

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

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

Param: ev

The event.

MDN Reference

onclick

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

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

Param: ev

The mouse event.

MDN Reference

onclose

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

MDN Reference

oncontextmenu

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

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

Param: ev

The mouse event.

MDN Reference

oncopy

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

MDN Reference

oncuechange

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

MDN Reference

oncut

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

MDN Reference

ondblclick

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

Fires when the user double-clicks the object.

Param: ev

The mouse event.

MDN Reference

ondrag

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

Fires on the source object continuously during a drag operation.

Param: ev

The event.

MDN Reference

ondragend

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

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

Param: ev

The event.

MDN Reference

ondragenter

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

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

Param: ev

The drag event.

MDN Reference

ondragleave

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

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

Param: ev

The drag event.

MDN Reference

ondragover

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

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

Param: ev

The event.

MDN Reference

ondragstart

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

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

Param: ev

The event.

MDN Reference

ondrop

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

MDN Reference

ondurationchange

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

Occurs when the duration attribute is updated.

Param: ev

The event.

MDN Reference

onemptied

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

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

Param: ev

The event.

MDN Reference

onended

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

Occurs when the end of playback is reached.

Param: ev

The event

MDN Reference

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus

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

Fires when the object receives focus.

Param: ev

The event.

MDN Reference

onformdata

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

MDN Reference

onfullscreenchange

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

MDN Reference

onfullscreenerror

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

MDN Reference

ongotpointercapture

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

MDN Reference

oninput

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

MDN Reference

oninvalid

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

MDN Reference

onkeydown

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

Fires when the user presses a key.

Param: ev

The keyboard event

MDN Reference

onkeypress

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

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

MDN Reference

onkeyup

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

Fires when the user releases a key.

Param: ev

The keyboard event

MDN Reference

onload

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

Fires immediately after the browser loads the object.

Param: ev

The event.

MDN Reference

onloadeddata

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

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

Param: ev

The event.

MDN Reference

onloadedmetadata

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

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

Param: ev

The event.

MDN Reference

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

MDN Reference

onlostpointercapture

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

MDN Reference

onmousedown

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

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

Param: ev

The mouse event.

MDN Reference

onmouseenter

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

MDN Reference

onmouseleave

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

MDN Reference

onmousemove

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

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

MDN Reference

onmouseout

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

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

Param: ev

The mouse event.

MDN Reference

onmouseover

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

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

Param: ev

The mouse event.

MDN Reference

onmouseup

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

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

Param: ev

The mouse event.

MDN Reference

onpaste

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

MDN Reference

onpause

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

Occurs when playback is paused.

Param: ev

The event.

MDN Reference

onplay

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

Occurs when the play method is requested.

Param: ev

The event.

MDN Reference

onplaying

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

Occurs when the audio or video has started playing.

Param: ev

The event.

MDN Reference

onpointercancel

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

MDN Reference

onpointerdown

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

MDN Reference

onpointerenter

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

MDN Reference

onpointerleave

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

MDN Reference

onpointermove

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

MDN Reference

onpointerout

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

MDN Reference

onpointerover

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

MDN Reference

onpointerup

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

MDN Reference

onprogress

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

Occurs to indicate progress while downloading media data.

Param: ev

The event.

MDN Reference

onratechange

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

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

MDN Reference

onreset

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

Fires when the user resets a form.

Param: ev

The event.

MDN Reference

onresize

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

MDN Reference

onscroll

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

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

Param: ev

The event.

MDN Reference

onscrollend

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

MDN Reference

onsecuritypolicyviolation

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

MDN Reference

onseeked

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

Occurs when the seek operation ends.

Param: ev

The event.

MDN Reference

onseeking

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

Occurs when the current playback position is moved.

Param: ev

The event.

MDN Reference

onselect

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

Fires when the current selection changes.

Param: ev

The event.

MDN Reference

onselectionchange

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

MDN Reference

onselectstart

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

MDN Reference

onslotchange

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

MDN Reference

onstalled

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

Occurs when the download has stopped.

Param: ev

The event.

MDN Reference

onsubmit

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

MDN Reference

onsuspend

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

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

MDN Reference

ontimeupdate

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

Occurs to indicate the current playback position.

Param: ev

The event.

MDN Reference

ontoggle

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

MDN Reference

Optionalontouchcancel

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

MDN Reference

Optionalontouchend

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

MDN Reference

Optionalontouchmove

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

MDN Reference

Optionalontouchstart

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

MDN Reference

ontransitioncancel

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

MDN Reference

ontransitionend

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

MDN Reference

ontransitionrun

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

MDN Reference

ontransitionstart

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

MDN Reference

onvolumechange

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

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

Param: ev

The event.

MDN Reference

onwaiting

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

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

Param: ev

The event.

MDN Reference

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel

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

MDN Reference

outerHTML

outerHTML: string

MDN Reference

outerText

outerText: string

MDN Reference

ReadonlyownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

ReadonlyparentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

ReadonlyparentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

Readonlypart

part: DOMTokenList

MDN Reference

popover

popover: null | string

MDN Reference

Readonlyprefix

prefix: null | string

Returns the namespace prefix.

MDN Reference

ReadonlypreviousElementSibling

previousElementSibling: null | Element

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

MDN Reference

ReadonlypreviousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

pristine

pristine: boolean

removeValidator

removeValidator: ((obj: UmbFormControlValidatorConfig) => void)

role

role: null | string

ReadonlyscrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

ReadonlyscrollWidth

scrollWidth: number

MDN Reference

ReadonlyshadowRoot

shadowRoot: null | ShadowRoot

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

MDN Reference

OptionalshowOpenButton

showOpenButton?: boolean

slot

slot: string

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

MDN Reference

spellcheck

spellcheck: boolean

MDN Reference

startNode

startNode: string = ''

Readonlystyle

style: CSSStyleDeclaration

MDN Reference

tabIndex

tabIndex: number

MDN Reference

ReadonlytagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

textContent

textContent: null | string

MDN Reference

title

title: string

MDN Reference

translate

translate: boolean

MDN Reference

Static[metadata]

[metadata]: object & Record<PropertyKey, unknown>

Static_$litElement$

_$litElement$: boolean

Static Optional_initializers

_initializers?: Initializer[]

Protected Staticfinalized

finalized: undefined | true

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

Nocollapse

Staticstyles

styles: CSSResult[] = ...

max

min

readonly

selection

validationMessage

validity

value

Protected_runValidators

addEventListener

  • addEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

ProtectedaddFormControlElement

addUmbController

after

  • after(...nodes): 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

animate

  • animate(keyframes, options?): Animation

  • MDN Reference

    Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optionaloptions: number | KeyframeAnimationOptions

    Returns Animation

append

  • append(...nodes): void

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

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

    MDN Reference

    Parameters

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

    Returns void

appendChild

  • appendChild<T>(node): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T

    Returns T

attachInternals

  • attachInternals(): ElementInternals

  • MDN Reference

    Returns ElementInternals

attachShadow

  • attachShadow(init): ShadowRoot

  • Creates a shadow root for element and returns it.

    MDN Reference

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

before

  • before(...nodes): void

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

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

    MDN Reference

    Parameters

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

    Returns void

blur

  • blur(): void

  • MDN Reference

    Returns void

checkValidity

checkVisibility

  • checkVisibility(options?): boolean

  • MDN Reference

    Parameters

    • Optionaloptions: CheckVisibilityOptions

    Returns boolean

click

  • click(): void

  • MDN Reference

    Returns void

cloneNode

  • cloneNode(deep?): Node

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

    MDN Reference

    Parameters

    • Optionaldeep: boolean

    Returns Node

closest

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

  • 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 null | HTMLElementTagNameMap[K]

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

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

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

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | MathMLElementTagNameMap[K]

  • closest<E>(selectors): null | E

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    MDN Reference

    Parameters

    • other: Node

    Returns number

computedStyleMap

  • computedStyleMap(): StylePropertyMapReadOnly

  • MDN Reference

    Returns StylePropertyMapReadOnly

consumeContext

contains

  • contains(other): boolean

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

    MDN Reference

    Parameters

    • other: null | Node

    Returns boolean

destroy

dispatchEvent

  • dispatchEvent(event): boolean

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

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

focus

  • focus(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: FocusOptions

    Returns void

focusFirstInvalidElement

formResetCallback

getAnimations

  • getAnimations(options?): Animation[]

  • MDN Reference

    Parameters

    • Optionaloptions: GetAnimationsOptions

    Returns Animation[]

getAttribute

  • getAttribute(qualifiedName): null | string

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

getAttributeNS

  • getAttributeNS(namespace, localName): null | 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: null | string
    • localName: string

    Returns null | string

getAttributeNames

  • getAttributeNames(): string[]

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

    MDN Reference

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName): null | Attr

  • MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace, localName): null | Attr

  • MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

getBoundingClientRect

  • getBoundingClientRect(): DOMRect

  • MDN Reference

    Returns DOMRect

getClientRects

  • getClientRects(): DOMRectList

  • MDN Reference

    Returns DOMRectList

getContext

  • getContext<BaseType, ResultType>(alias): Promise<ResultType>

  • Type Parameters

    Parameters

    Returns Promise<ResultType>

    A Promise with the reference to the Context Api Instance

    Description

    Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

    Memberof

    UmbClassInterface

getElementsByClassName

  • getElementsByClassName(classNames): HTMLCollectionOf<Element>

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

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

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

  • MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

  • MDN Reference

    Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<MathMLElement>

  • getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

ProtectedgetFormElement

getHostElement

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    MDN Reference

    Parameters

    • Optionaloptions: GetRootNodeOptions

    Returns Node

getUmbControllers

hasAttribute

  • hasAttribute(qualifiedName): boolean

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace, localName): boolean

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

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

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

    MDN Reference

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    MDN Reference

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId): boolean

  • MDN Reference

    Parameters

    • pointerId: number

    Returns boolean

hasUmbController

hidePopover

  • hidePopover(): void

  • MDN Reference

    Returns void

insertAdjacentElement

  • insertAdjacentElement(where, element): null | Element

  • MDN Reference

    Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

insertAdjacentHTML

  • insertAdjacentHTML(position, text): void

  • MDN Reference

    Parameters

    • position: InsertPosition
    • text: string

    Returns void

insertAdjacentText

  • insertAdjacentText(where, data): void

  • MDN Reference

    Parameters

    • where: InsertPosition
    • data: string

    Returns void

insertBefore

  • insertBefore<T>(node, child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix): null | string

  • MDN Reference

    Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • lookupPrefix(namespace): null | string

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns null | string

matches

  • matches(selectors): boolean

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

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

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

    MDN Reference

    Returns void

observe

prepend

  • prepend(...nodes): 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

provideContext

querySelector

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

  • 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 null | HTMLElementTagNameMap[K]

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

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

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

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | MathMLElementTagNameMap[K]

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

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementDeprecatedTagNameMap[K]

    Deprecated

  • querySelector<E>(selectors): null | E

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns null | E

querySelectorAll

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

  • Returns all element descendants of node that match selectors.

    MDN Reference

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

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

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

    Deprecated

  • querySelectorAll<E>(selectors): NodeListOf<E>

  • Type Parameters

    • E extends Element = Element

    Parameters

    • selectors: string

    Returns NodeListOf<E>

releasePointerCapture

  • releasePointerCapture(pointerId): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    MDN Reference

    Returns void

removeAttribute

  • removeAttribute(qualifiedName): void

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

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace, localName): void

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

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeAttributeNode

  • removeAttributeNode(attr): Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns Attr

removeChild

  • removeChild<T>(child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener<K>(type, listener, options?): void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: ((this: HTMLElement, ev: HTMLElementEventMap[K]) => any)
        • (this, ev): any

        • Parameters

          • this: HTMLElement
          • ev: HTMLElementEventMap[K]

          Returns any

    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • removeEventListener(type, listener, options?): void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

ProtectedremoveFormControlElement

removeUmbController

removeUmbControllerByAlias

replaceChild

  • replaceChild<T>(node, child): T

  • MDN Reference

    Type Parameters

    • T extends Node

    Parameters

    • node: Node
    • child: T

    Returns T

replaceChildren

  • replaceChildren(...nodes): void

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

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

    MDN Reference

    Parameters

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

    Returns void

replaceWith

  • replaceWith(...nodes): 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

requestFullscreen

  • requestFullscreen(options?): Promise<void>

  • Displays element fullscreen and resolves promise when done.

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

    MDN Reference

    Parameters

    • Optionaloptions: FullscreenOptions

    Returns Promise<void>

requestPointerLock

  • requestPointerLock(): void

  • MDN Reference

    Returns void

scroll

  • scroll(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scroll(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollBy(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

  • scrollIntoView(arg?): void

  • MDN Reference

    Parameters

    • Optionalarg: boolean | ScrollIntoViewOptions

    Returns void

scrollTo

  • scrollTo(options?): void

  • MDN Reference

    Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • scrollTo(x, y): void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName, value): 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

setAttributeNS

  • setAttributeNS(namespace, qualifiedName, value): void

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

    MDN Reference

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr): null | Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns null | Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr): null | Attr

  • MDN Reference

    Parameters

    • attr: Attr

    Returns null | Attr

setCustomValidity

setHTMLUnsafe

  • setHTMLUnsafe(html): void

  • Parameters

    • html: string

    Returns void

setPointerCapture

  • setPointerCapture(pointerId): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

showPopover

  • showPopover(): void

  • MDN Reference

    Returns void

submit

toggleAttribute

  • toggleAttribute(qualifiedName, force?): boolean

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

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

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

togglePopover

  • togglePopover(force?): boolean

  • MDN Reference

    Parameters

    • Optionalforce: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors): boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

StaticaddInitializer

  • addInitializer(initializer): void

  • 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

Protected Staticfinalize

  • finalize(): void

  • 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

attributes

StaticobservedAttributes

  • get observedAttributes(): string[]

  • Returns a list of attributes corresponding to the registered properties.

    Returns string[]

    Nocollapse

attributeChangedCallback

  • attributeChangedCallback(name, _old, value): void

  • 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: null | string
    • value: null | string

    Returns void

controllers

addController

  • addController(controller): void

  • 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

removeController

  • removeController(controller): void

  • Removes a ReactiveController from the element.

    Parameters

    • controller: ReactiveController

    Returns void

dev-mode

Static OptionaldisableWarning

disableWarning?: ((warningKind: 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');

Nocollapse

Static OptionalenableWarning

enableWarning?: ((warningKind: 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');

Nocollapse

Static OptionalenabledWarnings

enabledWarnings?: WarningKind[]

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

This property is only used in development builds.

Nocollapse

lifecycle

connectedCallback

  • connectedCallback(): void

  • 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

disconnectedCallback

  • disconnectedCallback(): 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

properties

StaticelementProperties

elementProperties: PropertyDeclarationMap

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

Nocollapse

Staticproperties

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

StaticcreateProperty

  • createProperty(name, options?): void

  • 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
    • Optionaloptions: PropertyDeclaration<unknown, unknown>

    Returns void

    Nocollapse

Protected StaticgetPropertyDescriptor

  • getPropertyDescriptor(name, key, options): undefined | PropertyDescriptor

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

    Nocollapse

StaticgetPropertyOptions

  • getPropertyOptions(name): PropertyDeclaration<unknown, unknown>

  • 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

rendering

ReadonlyrenderOptions

renderOptions: RenderOptions

ReadonlyrenderRoot

renderRoot: HTMLElement | DocumentFragment

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

StaticshadowRootOptions

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

ProtectedcreateRenderRoot

  • createRenderRoot(): HTMLElement | DocumentFragment

  • Returns HTMLElement | DocumentFragment

render

  • render(): TemplateResult<1>

  • Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

    Returns TemplateResult<1>

styles

StaticelementStyles

elementStyles: CSSResultOrNative[]

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

Nocollapse

Protected StaticfinalizeStyles

  • finalizeStyles(styles?): CSSResultOrNative[]

  • 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

    • Optionalstyles: CSSResultGroup

    Returns CSSResultOrNative[]

    Nocollapse

updates

hasUpdated

hasUpdated: boolean

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

isUpdatePending

isUpdatePending: boolean

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

updateComplete

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

ProtectedenableUpdating

  • enableUpdating(_requestedUpdate): void

  • 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

ProtectedfirstUpdated

  • firstUpdated(_changedProperties): 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

ProtectedgetUpdateComplete

  • getUpdateComplete(): Promise<boolean>

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

ProtectedperformUpdate

  • performUpdate(): void

  • 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

requestUpdate

  • requestUpdate(name?, oldValue?, options?): 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

    • Optionalname: PropertyKey

      name of requesting property

    • OptionaloldValue: unknown

      old value of requesting property

    • Optionaloptions: PropertyDeclaration<unknown, unknown>

      property options to use instead of the previously configured options

    Returns void

ProtectedscheduleUpdate

  • scheduleUpdate(): void | Promise<unknown>

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

ProtectedshouldUpdate

  • shouldUpdate(_changedProperties): boolean

  • 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

Protectedupdate

  • update(changedProperties): void

  • 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

Protectedupdated

  • updated(_changedProperties): 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

ProtectedwillUpdate

  • willUpdate(_changedProperties): 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

Settings

Member Visibility

On This Page

Other
constructorATTRIBUTE_NODECDATA_SECTION_NODECOMMENT_NODEDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_NODEENTITY_REFERENCE_NODENOTATION_NODEPROCESSING_INSTRUCTION_NODETEXT_NODE_internalsaccessKeyaccessKeyLabeladdValidatorallowedContentTypeIdsariaAtomicariaAutoCompleteariaBrailleLabelariaBrailleRoleDescriptionariaBusyariaCheckedariaColCountariaColIndexariaColSpanariaCurrentariaDescriptionariaDisabledariaExpandedariaHasPopupariaHiddenariaInvalidariaKeyShortcutsariaLabelariaLevelariaLiveariaModalariaMultiLineariaMultiSelectableariaOrientationariaPlaceholderariaPosInSetariaPressedariaReadOnlyariaRequiredariaRoleDescriptionariaRowCountariaRowIndexariaRowSpanariaSelectedariaSetSizeariaSortariaValueMaxariaValueMinariaValueNowariaValueTextassignedSlotattributeStyleMapattributesautocapitalizeautofocusbaseURIchildElementCountchildNodeschildrenclassListclassNameclientHeightclientLeftclientTopclientWidthcontentEditabledatasetdirdraggableenterKeyHintfirstChildfirstElementChildhiddenidinertinnerHTMLinnerTextinputModeisConnectedisContentEditablelanglastChildlastElementChildlocalNamelocalizemaxMessageminMessagenamespaceURInextElementSiblingnextSiblingnodeNamenodeTypenodeValuenonceoffsetHeightoffsetLeftoffsetParentoffsetTopoffsetWidthonabortonanimationcancelonanimationendonanimationiterationonanimationstartonauxclickonbeforeinputonbeforetoggleonbluroncanceloncanplayoncanplaythroughonchangeonclickoncloseoncontextmenuoncopyoncuechangeoncutondblclickondragondragendondragenterondragleaveondragoverondragstartondropondurationchangeonemptiedonendedonerroronfocusonformdataonfullscreenchangeonfullscreenerrorongotpointercaptureoninputoninvalidonkeydownonkeypressonkeyuponloadonloadeddataonloadedmetadataonloadstartonlostpointercaptureonmousedownonmouseenteronmouseleaveonmousemoveonmouseoutonmouseoveronmouseuponpasteonpauseonplayonplayingonpointercancelonpointerdownonpointerenteronpointerleaveonpointermoveonpointeroutonpointeroveronpointeruponprogressonratechangeonresetonresizeonscrollonscrollendonsecuritypolicyviolationonseekedonseekingonselectonselectionchangeonselectstartonslotchangeonstalledonsubmitonsuspendontimeupdateontoggleontouchcancelontouchendontouchmoveontouchstartontransitioncancelontransitionendontransitionrunontransitionstartonvolumechangeonwaitingonwebkitanimationendonwebkitanimationiterationonwebkitanimationstartonwebkittransitionendonwheelouterHTMLouterTextownerDocumentparentElementparentNodepartpopoverprefixpreviousElementSiblingpreviousSiblingpristineremoveValidatorrolescrollHeightscrollLeftscrollTopscrollWidthshadowRootshowOpenButtonslotspellcheckstartNodestyletabIndextagNametextContenttitletranslate[metadata]_$litElement$_initializersfinalizedstylesmaxminreadonlyselectionvalidationMessagevalidityvalue_runValidatorsaddEventListeneraddFormControlElementaddUmbControllerafteranimateappendappendChildattachInternalsattachShadowbeforeblurcheckValiditycheckVisibilityclickcloneNodeclosestcompareDocumentPositioncomputedStyleMapconsumeContextcontainsdestroydispatchEventfocusfocusFirstInvalidElementformResetCallbackgetAnimationsgetAttributegetAttributeNSgetAttributeNamesgetAttributeNodegetAttributeNodeNSgetBoundingClientRectgetClientRectsgetContextgetElementsByClassNamegetElementsByTagNamegetElementsByTagNameNSgetFormElementgetHostElementgetRootNodegetUmbControllershasAttributehasAttributeNShasAttributeshasChildNodeshasPointerCapturehasUmbControllerhidePopoverinsertAdjacentElementinsertAdjacentHTMLinsertAdjacentTextinsertBeforeisDefaultNamespaceisEqualNodeisSameNodelookupNamespaceURIlookupPrefixmatchesnormalizeobserveprependprovideContextquerySelectorquerySelectorAllreleasePointerCaptureremoveremoveAttributeremoveAttributeNSremoveAttributeNoderemoveChildremoveEventListenerremoveFormControlElementremoveUmbControllerremoveUmbControllerByAliasreplaceChildreplaceChildrenreplaceWithrequestFullscreenrequestPointerLockscrollscrollByscrollIntoViewscrollTosetAttributesetAttributeNSsetAttributeNodesetAttributeNodeNSsetCustomValiditysetHTMLUnsafesetPointerCaptureshowPopoversubmittoggleAttributetogglePopoverwebkitMatchesSelectoraddInitializerfinalize
attributes
controllers
dev-mode
lifecycle
properties
rendering
styles
updates
""