Parameter	Type
`name`	`"blur"` \| `"click"` \| `"copy"` \| `"cut"` \| `"drop"` \| `"focus"` \| `"paste"` \| `"wheel"` \| `"compositionEnd"` \| `"doubleClick"` \| `"tripleClick"` \| `"pointerDown"` \| `"pointerMove"` \| `"pointerUp"` \| `"pointerOut"` \| `"dragStart"` \| `"dragMove"` \| `"dragEnd"` \| `"keyDown"` \| `"keyUp"` \| `"selectionChange"` \| `"compositionStart"` \| `"compositionUpdate"` \| `"beforeInput"` \| `"contextMenu"`
`handler`	`UIEventHandler`
`options`?	`object`
`options.global`?	`boolean`

Returns

void

Defined In

packages/lit/dist/element/widget-element.d.ts:17

Inherited from

WidgetElement.handleEvent

hidden

hidden: boolean

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10060

Inherited from

WidgetElement.hidden

id

id: string

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7624

Inherited from

WidgetElement.id

inert

inert: boolean

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10062

Inherited from

WidgetElement.inert

innerHTML

innerHTML: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:14277

Inherited from

WidgetElement.innerHTML

innerText

innerText: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10064

Inherited from

WidgetElement.innerText

inputMode

inputMode: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7864

Inherited from

WidgetElement.inputMode

isConnected

readonly isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16090

Inherited from

WidgetElement.isConnected

isContentEditable

readonly isContentEditable: boolean

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7866

Inherited from

WidgetElement.isContentEditable

lang

lang: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10066

Inherited from

WidgetElement.lang

lastChild

readonly lastChild: null | ChildNode

Returns the last child.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16096

Inherited from

WidgetElement.lastChild

lastElementChild

readonly lastElementChild: null | Element

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16779

Inherited from

WidgetElement.lastElementChild

localName

readonly localName: string

Returns the local name.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7630

Inherited from

WidgetElement.localName

namespaceURI

readonly namespaceURI: null | string

Returns the namespace.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7636

Inherited from

WidgetElement.namespaceURI

nextElementSibling

readonly nextElementSibling: null | Element

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16352

Inherited from

WidgetElement.nextElementSibling

nextSibling

readonly nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16102

Inherited from

WidgetElement.nextSibling

nodeName

readonly nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16108

Inherited from

WidgetElement.nodeName

nodeType

readonly nodeType: number

Returns the type of node.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16114

Inherited from

WidgetElement.nodeType

nodeValue

nodeValue: null | string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16116

Inherited from

WidgetElement.nodeValue

nonce

optional nonce: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:12047

Inherited from

WidgetElement.nonce

offsetHeight

readonly offsetHeight: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10068

Inherited from

WidgetElement.offsetHeight

offsetLeft

readonly offsetLeft: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10070

Inherited from

WidgetElement.offsetLeft

offsetParent

readonly offsetParent: null | Element

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10072

Inherited from

WidgetElement.offsetParent

offsetTop

readonly offsetTop: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10074

Inherited from

WidgetElement.offsetTop

offsetWidth

readonly offsetWidth: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10076

Inherited from

WidgetElement.offsetWidth

onabort

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

Fires when the user aborts the download.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8946

Inherited from

WidgetElement.onabort

onanimationcancel

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8948

Inherited from

WidgetElement.onanimationcancel

onanimationend

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8950

Inherited from

WidgetElement.onanimationend

onanimationiteration

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8952

Inherited from

WidgetElement.onanimationiteration

onanimationstart

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8954

Inherited from

WidgetElement.onanimationstart

onauxclick

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8956

Inherited from

WidgetElement.onauxclick

onbeforeinput

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8958

Inherited from

WidgetElement.onbeforeinput

onblur

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

Fires when the object loses the input focus.

Param

The focus event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8965

Inherited from

WidgetElement.onblur

oncancel

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8967

Inherited from

WidgetElement.oncancel

oncanplay

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8974

Inherited from

WidgetElement.oncanplay

oncanplaythrough

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8976

Inherited from

WidgetElement.oncanplaythrough

onchange

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8983

Inherited from

WidgetElement.onchange

onclick

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8990

Inherited from

WidgetElement.onclick

onclose

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8992

Inherited from

WidgetElement.onclose

oncontextmenu

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8999

Inherited from

WidgetElement.oncontextmenu

oncopy

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9001

Inherited from

WidgetElement.oncopy

oncuechange

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9003

Inherited from

WidgetElement.oncuechange

oncut

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9005

Inherited from

WidgetElement.oncut

ondblclick

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

Fires when the user double-clicks the object.

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9012

Inherited from

WidgetElement.ondblclick

ondrag

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

Fires on the source object continuously during a drag operation.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9019

Inherited from

WidgetElement.ondrag

ondragend

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9026

Inherited from

WidgetElement.ondragend

ondragenter

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

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

Param

The drag event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9033

Inherited from

WidgetElement.ondragenter

ondragleave

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

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

Param

The drag event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9040

Inherited from

WidgetElement.ondragleave

ondragover

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9047

Inherited from

WidgetElement.ondragover

ondragstart

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9054

Inherited from

WidgetElement.ondragstart

ondrop

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9056

Inherited from

WidgetElement.ondrop

ondurationchange

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

Occurs when the duration attribute is updated.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9063

Inherited from

WidgetElement.ondurationchange

onemptied

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9070

Inherited from

WidgetElement.onemptied

onended

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

Occurs when the end of playback is reached.

Param

The event

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9077

Inherited from

WidgetElement.onended

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9084

Inherited from

WidgetElement.onerror

onfocus

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

Fires when the object receives focus.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9091

Inherited from

WidgetElement.onfocus

onformdata

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9093

Inherited from

WidgetElement.onformdata

onfullscreenchange

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7638

Inherited from

WidgetElement.onfullscreenchange

onfullscreenerror

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7640

Inherited from

WidgetElement.onfullscreenerror

ongotpointercapture

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9095

Inherited from

WidgetElement.ongotpointercapture

oninput

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9097

Inherited from

WidgetElement.oninput

oninvalid

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9099

Inherited from

WidgetElement.oninvalid

onkeydown

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

Fires when the user presses a key.

Param

The keyboard event

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9106

Inherited from

WidgetElement.onkeydown

onkeypress

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

Fires when the user presses an alphanumeric key.

Param

The event.

Deprecated

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9114

Inherited from

WidgetElement.onkeypress

onkeyup

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

Fires when the user releases a key.

Param

The keyboard event

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9121

Inherited from

WidgetElement.onkeyup

onload

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

Fires immediately after the browser loads the object.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9128

Inherited from

WidgetElement.onload

onloadeddata

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9135

Inherited from

WidgetElement.onloadeddata

onloadedmetadata

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9142

Inherited from

WidgetElement.onloadedmetadata

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9149

Inherited from

WidgetElement.onloadstart

onlostpointercapture

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9151

Inherited from

WidgetElement.onlostpointercapture

onmousedown

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9158

Inherited from

WidgetElement.onmousedown

onmouseenter

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9160

Inherited from

WidgetElement.onmouseenter

onmouseleave

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9162

Inherited from

WidgetElement.onmouseleave

onmousemove

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

Fires when the user moves the mouse over the object.

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9169

Inherited from

WidgetElement.onmousemove

onmouseout

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9176

Inherited from

WidgetElement.onmouseout

onmouseover

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9183

Inherited from

WidgetElement.onmouseover

onmouseup

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

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

Param

The mouse event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9190

Inherited from

WidgetElement.onmouseup

onpaste

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9192

Inherited from

WidgetElement.onpaste

onpause

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

Occurs when playback is paused.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9199

Inherited from

WidgetElement.onpause

onplay

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

Occurs when the play method is requested.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9206

Inherited from

WidgetElement.onplay

onplaying

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

Occurs when the audio or video has started playing.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9213

Inherited from

WidgetElement.onplaying

onpointercancel

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9215

Inherited from

WidgetElement.onpointercancel

onpointerdown

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9217

Inherited from

WidgetElement.onpointerdown

onpointerenter

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9219

Inherited from

WidgetElement.onpointerenter

onpointerleave

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9221

Inherited from

WidgetElement.onpointerleave

onpointermove

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9223

Inherited from

WidgetElement.onpointermove

onpointerout

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9225

Inherited from

WidgetElement.onpointerout

onpointerover

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9227

Inherited from

WidgetElement.onpointerover

onpointerup

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9229

Inherited from

WidgetElement.onpointerup

onprogress

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

Occurs to indicate progress while downloading media data.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9236

Inherited from

WidgetElement.onprogress

onratechange

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

Occurs when the playback rate is increased or decreased.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9243

Inherited from

WidgetElement.onratechange

onreset

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

Fires when the user resets a form.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9250

Inherited from

WidgetElement.onreset

onresize

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9252

Inherited from

WidgetElement.onresize

onscroll

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9259

Inherited from

WidgetElement.onscroll

onscrollend

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9261

Inherited from

WidgetElement.onscrollend

onsecuritypolicyviolation

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9263

Inherited from

WidgetElement.onsecuritypolicyviolation

onseeked

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

Occurs when the seek operation ends.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9270

Inherited from

WidgetElement.onseeked

onseeking

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

Occurs when the current playback position is moved.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9277

Inherited from

WidgetElement.onseeking

onselect

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

Fires when the current selection changes.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9284

Inherited from

WidgetElement.onselect

onselectionchange

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9286

Inherited from

WidgetElement.onselectionchange

onselectstart

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9288

Inherited from

WidgetElement.onselectstart

onslotchange

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9290

Inherited from

WidgetElement.onslotchange

onstalled

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

Occurs when the download has stopped.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9297

Inherited from

WidgetElement.onstalled

onsubmit

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9299

Inherited from

WidgetElement.onsubmit

onsuspend

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

Occurs if the load operation has been intentionally halted.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9306

Inherited from

WidgetElement.onsuspend

ontimeupdate

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

Occurs to indicate the current playback position.

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9313

Inherited from

WidgetElement.ontimeupdate

ontoggle

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9315

Inherited from

WidgetElement.ontoggle

ontouchcancel

optional ontouchcancel: null | (this, ev) => any

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9317

Inherited from

WidgetElement.ontouchcancel

ontouchend

optional ontouchend: null | (this, ev) => any

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9319

Inherited from

WidgetElement.ontouchend

ontouchmove

optional ontouchmove: null | (this, ev) => any

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9321

Inherited from

WidgetElement.ontouchmove

ontouchstart

optional ontouchstart: null | (this, ev) => any

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9323

Inherited from

WidgetElement.ontouchstart

ontransitioncancel

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9325

Inherited from

WidgetElement.ontransitioncancel

ontransitionend

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9327

Inherited from

WidgetElement.ontransitionend

ontransitionrun

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9329

Inherited from

WidgetElement.ontransitionrun

ontransitionstart

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9331

Inherited from

WidgetElement.ontransitionstart

onvolumechange

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9338

Inherited from

WidgetElement.onvolumechange

onwaiting

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

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

Param

The event.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9345

Inherited from

WidgetElement.onwaiting

onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9351

Inherited from

WidgetElement.onwebkitanimationend

onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9357

Inherited from

WidgetElement.onwebkitanimationiteration

onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9363

Inherited from

WidgetElement.onwebkitanimationstart

onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9369

Inherited from

WidgetElement.onwebkittransitionend

onwheel

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:9371

Inherited from

WidgetElement.onwheel

options

options: LinkedPageOptions = AffineLinkedPageWidget.DEFAULT_OPTIONS

Defined In

packages/blocks/src/_common/widgets/linked-page/index.ts:94

outerHTML

outerHTML: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7642

Inherited from

WidgetElement.outerHTML

outerText

outerText: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10078

Inherited from

WidgetElement.outerText

ownerDocument

readonly ownerDocument: Document

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7643

Inherited from

WidgetElement.ownerDocument

parentElement

readonly parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16128

Inherited from

WidgetElement.parentElement

parentNode

readonly parentNode: null | ParentNode

Returns the parent.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16134

Inherited from

WidgetElement.parentNode

part

readonly part: DOMTokenList

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7645

Inherited from

WidgetElement.part

path

path: string[]

Defined In

packages/lit/dist/element/widget-element.d.ts:11

Inherited from

WidgetElement.path

popover: null | string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10080

Inherited from

WidgetElement.popover

prefix

readonly prefix: null | string

Returns the namespace prefix.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7651

Inherited from

WidgetElement.prefix

previousElementSibling

readonly previousElementSibling: null | Element

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16358

Inherited from

WidgetElement.previousElementSibling

previousSibling

readonly previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16140

Inherited from

WidgetElement.previousSibling

role

role: null | string

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:2279

Inherited from

WidgetElement.role

root

root: BlockSuiteRoot

Defined In

packages/lit/dist/element/widget-element.d.ts:9

Inherited from

WidgetElement.root

scrollHeight

readonly scrollHeight: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7653

Inherited from

WidgetElement.scrollHeight

scrollLeft

scrollLeft: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7655

Inherited from

WidgetElement.scrollLeft

scrollTop

scrollTop: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7657

Inherited from

WidgetElement.scrollTop

scrollWidth

readonly scrollWidth: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7659

Inherited from

WidgetElement.scrollWidth

shadowRoot

readonly shadowRoot: null | ShadowRoot

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7665

Inherited from

WidgetElement.shadowRoot

slot

slot: string

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

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7671

Inherited from

WidgetElement.slot

spellcheck

spellcheck: boolean

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10082

Inherited from

WidgetElement.spellcheck

style

readonly style: CSSStyleDeclaration

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7855

Inherited from

WidgetElement.style

tabIndex

tabIndex: number

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:12049

Inherited from

WidgetElement.tabIndex

tagName

readonly tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7677

Inherited from

WidgetElement.tagName

textContent

textContent: null | string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16142

Inherited from

WidgetElement.textContent

title

title: string

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10084

Inherited from

WidgetElement.title

translate

translate: boolean

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10085

Inherited from

WidgetElement.translate

DEFAULT_OPTIONS

static DEFAULT_OPTIONS: LinkedPageOptions

Defined In

packages/blocks/src/_common/widgets/linked-page/index.ts:81

[metadata]

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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:417

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.esnext.decorators.d.ts:27

Inherited from

WidgetElement.[metadata]

_$litElement$

static _$litElement$: boolean

Defined In

node_modules/.pnpm/lit-element@4.0.1/node_modules/lit-element/development/lit-element.d.ts:84

Inherited from

WidgetElement._$litElement$

_initializers

static optional _initializers: Initializer[]

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:258

Inherited from

WidgetElement._initializers

finalized

protected static 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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:272

Inherited from

WidgetElement.finalized

blockElement

get blockElement(): B

Defined In

packages/lit/dist/element/widget-element.d.ts:14

Inherited from

WidgetElement.blockElement

flavour

get flavour(): string

Defined In

packages/lit/dist/element/widget-element.d.ts:15

Inherited from

WidgetElement.flavour

hostPath

get hostPath(): string[]

Defined In

packages/lit/dist/element/widget-element.d.ts:13

Inherited from

WidgetElement.hostPath

std

get std(): BlockStdProvider

Defined In

packages/lit/dist/element/widget-element.d.ts:16

Inherited from

WidgetElement.std

widgetName

get widgetName(): string

Defined In

packages/lit/dist/element/widget-element.d.ts:12

Inherited from

WidgetElement.widgetName

_onKeyDown

private _onKeyDown(ctx): void

Parameters

Parameter	Type
`ctx`	`UIEventStateContext`

Returns

void

Defined In

packages/blocks/src/_common/widgets/linked-page/index.ts:111

addEventListener

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

Type parameters

Parameter
`K` extends keyof `HTMLElementEventMap`

Parameters

Parameter	Type
`type`	`K`
`listener`	`function`
`options`?	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

WidgetElement.addEventListener

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10096

addEventListener( type, listener, options?): void

Parameters

Parameter	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options`?	`boolean` \| `AddEventListenerOptions`

Returns

void

Inherited from

WidgetElement.addEventListener

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10097

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.after

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:5597

animate

animate(keyframes, options?): Animation

MDN Reference

Parameters

Parameter	Type
`keyframes`	`null` \| `Keyframe`[] \| `PropertyIndexedKeyframes`
`options`?	`number` \| `KeyframeAnimationOptions`

Returns

Animation

Inherited from

WidgetElement.animate

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:2429

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.append

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16787

appendChild

appendChild<T>(node): T

MDN Reference

Type parameters

Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`

Returns

T

Inherited from

WidgetElement.appendChild

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16144

attachInternals

attachInternals(): ElementInternals

MDN Reference

Returns

ElementInternals

Inherited from

WidgetElement.attachInternals

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10087

attachShadow

attachShadow(init): ShadowRoot

Creates a shadow root for element and returns it.

MDN Reference

Parameters

Parameter	Type
`init`	`ShadowRootInit`

Returns

ShadowRoot

Inherited from

WidgetElement.attachShadow

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7683

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.before

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:5605

bindHotKey

bindHotKey(keymap, options?): void

Parameters

Parameter	Type
`keymap`	`Record`< `string`, `UIEventHandler` >
`options`?	`object`
`options.global`?	`boolean`

Returns

void

Inherited from

WidgetElement.bindHotKey

Defined In

packages/lit/dist/element/widget-element.d.ts:20

blur

blur(): void

MDN Reference

Returns

void

Inherited from

WidgetElement.blur

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:12051

checkVisibility

checkVisibility(options?): boolean

Parameters

Parameter	Type
`options`?	`CheckVisibilityOptions`

Returns

boolean

Inherited from

WidgetElement.checkVisibility

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7684

click

click(): void

MDN Reference

Returns

void

Inherited from

WidgetElement.click

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10089

cloneNode

cloneNode(deep?): Node

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

MDN Reference

Parameters

Parameter	Type
`deep`?	`boolean`

Returns

Node

Inherited from

WidgetElement.cloneNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16150

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

Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

null | HTMLElementTagNameMap[K]

Inherited from

WidgetElement.closest

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7690

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

Type parameters

Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

null | SVGElementTagNameMap[K]

Inherited from

WidgetElement.closest

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7691

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

Type parameters

Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selector`	`K`

Returns

null | MathMLElementTagNameMap[K]

Inherited from

WidgetElement.closest

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7692

closest<E>(selectors): null | E

Type parameters

Parameter	Default
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

null | E

Inherited from

WidgetElement.closest

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7693

compareDocumentPosition

compareDocumentPosition(other): number

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

MDN Reference

Parameters

Parameter	Type
`other`	`Node`

Returns

number

Inherited from

WidgetElement.compareDocumentPosition

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16156

computedStyleMap

computedStyleMap(): StylePropertyMapReadOnly

MDN Reference

Returns

StylePropertyMapReadOnly

Inherited from

WidgetElement.computedStyleMap

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7695

connectedCallback

connectedCallback(): void

Returns

void

Overrides

WidgetElement.connectedCallback

Defined In

packages/blocks/src/_common/widgets/linked-page/index.ts:96

contains

contains(other): boolean

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

MDN Reference

Parameters

Parameter	Type
`other`	`null` \| `Node`

Returns

boolean

Inherited from

WidgetElement.contains

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16162

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

Parameter	Type
`event`	`Event`

Returns

boolean

Inherited from

WidgetElement.dispatchEvent

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:8215

focus

focus(options?): void

MDN Reference

Parameters

Parameter	Type
`options`?	`FocusOptions`

Returns

void

Inherited from

WidgetElement.focus

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:12053

getAnimations

getAnimations(options?): Animation[]

MDN Reference

Parameters

Parameter	Type
`options`?	`GetAnimationsOptions`

Returns

Animation[]

Inherited from

WidgetElement.getAnimations

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:2431

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

Parameter	Type
`qualifiedName`	`string`

Returns

null | string

Inherited from

WidgetElement.getAttribute

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7701

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

Parameter	Type
`namespace`	`null` \| `string`
`localName`	`string`

Returns

null | string

Inherited from

WidgetElement.getAttributeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7707

getAttributeNames

getAttributeNames(): string[]

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

MDN Reference

Returns

string[]

Inherited from

WidgetElement.getAttributeNames

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7713

getAttributeNode

getAttributeNode(qualifiedName): null | Attr

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

null | Attr

Inherited from

WidgetElement.getAttributeNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7715

getAttributeNodeNS

getAttributeNodeNS(namespace, localName): null | Attr

MDN Reference

Parameters

Parameter	Type
`namespace`	`null` \| `string`
`localName`	`string`

Returns

null | Attr

Inherited from

WidgetElement.getAttributeNodeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7717

getBoundingClientRect

getBoundingClientRect(): DOMRect

MDN Reference

Returns

DOMRect

Inherited from

WidgetElement.getBoundingClientRect

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7719

getClientRects

getClientRects(): DOMRectList

MDN Reference

Returns

DOMRectList

Inherited from

WidgetElement.getClientRects

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7721

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

Parameter	Type
`classNames`	`string`

Returns

HTMLCollectionOf< Element >

Inherited from

WidgetElement.getElementsByClassName

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7727

getElementsByTagName

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

MDN Reference

Type parameters

Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf< HTMLElementTagNameMap[K] >

Inherited from

WidgetElement.getElementsByTagName

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7729

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

Type parameters

Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf< SVGElementTagNameMap[K] >

Inherited from

WidgetElement.getElementsByTagName

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7730

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

Type parameters

Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf< MathMLElementTagNameMap[K] >

Inherited from

WidgetElement.getElementsByTagName

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7731

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

Type parameters

Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`qualifiedName`	`K`

Returns

HTMLCollectionOf< HTMLElementDeprecatedTagNameMap[K] >

Inherited from

WidgetElement.getElementsByTagName

Deprecated

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7733

getElementsByTagName(qualifiedName): HTMLCollectionOf< Element >

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

HTMLCollectionOf< Element >

Inherited from

WidgetElement.getElementsByTagName

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7734

getElementsByTagNameNS

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf< HTMLElement >

MDN Reference

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/1999/xhtml"`
`localName`	`string`

Returns

HTMLCollectionOf< HTMLElement >

Inherited from

WidgetElement.getElementsByTagNameNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7736

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf< SVGElement >

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/2000/svg"`
`localName`	`string`

Returns

HTMLCollectionOf< SVGElement >

Inherited from

WidgetElement.getElementsByTagNameNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7737

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf< MathMLElement >

Parameters

Parameter	Type
`namespaceURI`	`"http://www.w3.org/1998/Math/MathML"`
`localName`	`string`

Returns

HTMLCollectionOf< MathMLElement >

Inherited from

WidgetElement.getElementsByTagNameNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7738

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf< Element >

Parameters

Parameter	Type
`namespace`	`null` \| `string`
`localName`	`string`

Returns

HTMLCollectionOf< Element >

Inherited from

WidgetElement.getElementsByTagNameNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7739

getRootNode

getRootNode(options?): Node

Returns node's root.

MDN Reference

Parameters

Parameter	Type
`options`?	`GetRootNodeOptions`

Returns

Node

Inherited from

WidgetElement.getRootNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16168

hasAttribute

hasAttribute(qualifiedName): boolean

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

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

boolean

Inherited from

WidgetElement.hasAttribute

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7745

hasAttributeNS

hasAttributeNS(namespace, localName): boolean

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

MDN Reference

Parameters

Parameter	Type
`namespace`	`null` \| `string`
`localName`	`string`

Returns

boolean

Inherited from

WidgetElement.hasAttributeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7751

hasAttributes

hasAttributes(): boolean

Returns true if element has attributes, and false otherwise.

MDN Reference

Returns

boolean

Inherited from

WidgetElement.hasAttributes

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7757

hasChildNodes

hasChildNodes(): boolean

Returns whether node has children.

MDN Reference

Returns

boolean

Inherited from

WidgetElement.hasChildNodes

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16174

hasPointerCapture

hasPointerCapture(pointerId): boolean

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

boolean

Inherited from

WidgetElement.hasPointerCapture

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7759

hidePopover

hidePopover(): void

MDN Reference

Returns

void

Inherited from

WidgetElement.hidePopover

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10091

insertAdjacentElement

insertAdjacentElement(where, element): null | Element

MDN Reference

Parameters

Parameter	Type
`where`	`InsertPosition`
`element`	`Element`

Returns

null | Element

Inherited from

WidgetElement.insertAdjacentElement

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7761

insertAdjacentHTML

insertAdjacentHTML(position, text): void

MDN Reference

Parameters

Parameter	Type
`position`	`InsertPosition`
`text`	`string`

Returns

void

Inherited from

WidgetElement.insertAdjacentHTML

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7763

insertAdjacentText

insertAdjacentText(where, data): void

MDN Reference

Parameters

Parameter	Type
`where`	`InsertPosition`
`data`	`string`

Returns

void

Inherited from

WidgetElement.insertAdjacentText

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7765

insertBefore

insertBefore<T>(node, child): T

MDN Reference

Type parameters

Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`T`
`child`	`null` \| `Node`

Returns

T

Inherited from

WidgetElement.insertBefore

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16176

isDefaultNamespace

isDefaultNamespace(namespace): boolean

MDN Reference

Parameters

Parameter	Type
`namespace`	`null` \| `string`

Returns

boolean

Inherited from

WidgetElement.isDefaultNamespace

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16178

isEqualNode

isEqualNode(otherNode): boolean

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

Parameter	Type
`otherNode`	`null` \| `Node`

Returns

boolean

Inherited from

WidgetElement.isEqualNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16184

isSameNode

isSameNode(otherNode): boolean

MDN Reference

Parameters

Parameter	Type
`otherNode`	`null` \| `Node`

Returns

boolean

Inherited from

WidgetElement.isSameNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16186

lookupNamespaceURI

lookupNamespaceURI(prefix): null | string

MDN Reference

Parameters

Parameter	Type
`prefix`	`null` \| `string`

Returns

null | string

Inherited from

WidgetElement.lookupNamespaceURI

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16188

lookupPrefix

lookupPrefix(namespace): null | string

MDN Reference

Parameters

Parameter	Type
`namespace`	`null` \| `string`

Returns

null | string

Inherited from

WidgetElement.lookupPrefix

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16190

matches

matches(selectors): boolean

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

MDN Reference

Parameters

Parameter	Type
`selectors`	`string`

Returns

boolean

Inherited from

WidgetElement.matches

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7771

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

Inherited from

WidgetElement.normalize

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16196

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.prepend

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16795

querySelector

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

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

MDN Reference

Type parameters

Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

null | HTMLElementTagNameMap[K]

Inherited from

WidgetElement.querySelector

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16801

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

Type parameters

Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

null | SVGElementTagNameMap[K]

Inherited from

WidgetElement.querySelector

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16802

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

Type parameters

Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

null | MathMLElementTagNameMap[K]

Inherited from

WidgetElement.querySelector

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16803

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

Type parameters

Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

null | HTMLElementDeprecatedTagNameMap[K]

Inherited from

WidgetElement.querySelector

Deprecated

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16805

querySelector<E>(selectors): null | E

Type parameters

Parameter	Default
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

null | E

Inherited from

WidgetElement.querySelector

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16806

querySelectorAll

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

Returns all element descendants of node that match selectors.

MDN Reference

Type parameters

Parameter
`K` extends keyof `HTMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf< HTMLElementTagNameMap[K] >

Inherited from

WidgetElement.querySelectorAll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16812

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

Type parameters

Parameter
`K` extends keyof `SVGElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf< SVGElementTagNameMap[K] >

Inherited from

WidgetElement.querySelectorAll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16813

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

Type parameters

Parameter
`K` extends keyof `MathMLElementTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf< MathMLElementTagNameMap[K] >

Inherited from

WidgetElement.querySelectorAll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16814

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

Type parameters

Parameter
`K` extends keyof `HTMLElementDeprecatedTagNameMap`

Parameters

Parameter	Type
`selectors`	`K`

Returns

NodeListOf< HTMLElementDeprecatedTagNameMap[K] >

Inherited from

WidgetElement.querySelectorAll

Deprecated

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16816

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

Type parameters

Parameter	Default
`E` extends `Element`	`Element`

Parameters

Parameter	Type
`selectors`	`string`

Returns

NodeListOf< E >

Inherited from

WidgetElement.querySelectorAll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16817

releasePointerCapture

releasePointerCapture(pointerId): void

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

void

Inherited from

WidgetElement.releasePointerCapture

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7773

remove

remove(): void

Removes node.

MDN Reference

Returns

void

Inherited from

WidgetElement.remove

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:5611

removeAttribute

removeAttribute(qualifiedName): void

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

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`

Returns

void

Inherited from

WidgetElement.removeAttribute

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7779

removeAttributeNS

removeAttributeNS(namespace, localName): void

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

MDN Reference

Parameters

Parameter	Type
`namespace`	`null` \| `string`
`localName`	`string`

Returns

void

Inherited from

WidgetElement.removeAttributeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7785

removeAttributeNode

removeAttributeNode(attr): Attr

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

Attr

Inherited from

WidgetElement.removeAttributeNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7787

removeChild

removeChild<T>(child): T

MDN Reference

Type parameters

Parameter
`T` extends `Node`

Parameters

Parameter	Type
`child`	`T`

Returns

T

Inherited from

WidgetElement.removeChild

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16198

removeEventListener

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

Type parameters

Parameter
`K` extends keyof `HTMLElementEventMap`

Parameters

Parameter	Type
`type`	`K`
`listener`	`function`
`options`?	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

WidgetElement.removeEventListener

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10098

removeEventListener( type, listener, options?): void

Parameters

Parameter	Type
`type`	`string`
`listener`	`EventListenerOrEventListenerObject`
`options`?	`boolean` \| `EventListenerOptions`

Returns

void

Inherited from

WidgetElement.removeEventListener

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10099

render

render(): unknown

Returns

unknown

Inherited from

WidgetElement.render

Defined In

packages/lit/dist/element/widget-element.d.ts:24

replaceChild

replaceChild<T>(node, child): T

MDN Reference

Type parameters

Parameter
`T` extends `Node`

Parameters

Parameter	Type
`node`	`Node`
`child`	`T`

Returns

T

Inherited from

WidgetElement.replaceChild

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16200

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.replaceChildren

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:16825

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

Parameter	Type
...`nodes`	(`string` \| `Node`)[]

Returns

void

Inherited from

WidgetElement.replaceWith

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:5619

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

Parameter	Type
`options`?	`FullscreenOptions`

Returns

Promise< void >

Inherited from

WidgetElement.requestFullscreen

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7795

requestPointerLock

requestPointerLock(): void

MDN Reference

Returns

void

Inherited from

WidgetElement.requestPointerLock

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7797

scroll

scroll(options?): void

MDN Reference

Parameters

Parameter	Type
`options`?	`ScrollToOptions`

Returns

void

Inherited from

WidgetElement.scroll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7799

scroll(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

WidgetElement.scroll

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7800

scrollBy

scrollBy(options?): void

MDN Reference

Parameters

Parameter	Type
`options`?	`ScrollToOptions`

Returns

void

Inherited from

WidgetElement.scrollBy

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7802

scrollBy(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

WidgetElement.scrollBy

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7803

scrollIntoView

scrollIntoView(arg?): void

MDN Reference

Parameters

Parameter	Type
`arg`?	`boolean` \| `ScrollIntoViewOptions`

Returns

void

Inherited from

WidgetElement.scrollIntoView

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7805

scrollTo

scrollTo(options?): void

MDN Reference

Parameters

Parameter	Type
`options`?	`ScrollToOptions`

Returns

void

Inherited from

WidgetElement.scrollTo

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7807

scrollTo(x, y): void

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

void

Inherited from

WidgetElement.scrollTo

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7808

setAttribute

setAttribute(qualifiedName, value): void

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

MDN Reference

Parameters

Parameter	Type
`qualifiedName`	`string`
`value`	`string`

Returns

void

Inherited from

WidgetElement.setAttribute

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7814

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

Parameter	Type
`namespace`	`null` \| `string`
`qualifiedName`	`string`
`value`	`string`

Returns

void

Inherited from

WidgetElement.setAttributeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7820

setAttributeNode

setAttributeNode(attr): null | Attr

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

null | Attr

Inherited from

WidgetElement.setAttributeNode

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7822

setAttributeNodeNS

setAttributeNodeNS(attr): null | Attr

MDN Reference

Parameters

Parameter	Type
`attr`	`Attr`

Returns

null | Attr

Inherited from

WidgetElement.setAttributeNodeNS

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7824

setPointerCapture

setPointerCapture(pointerId): void

MDN Reference

Parameters

Parameter	Type
`pointerId`	`number`

Returns

void

Inherited from

WidgetElement.setPointerCapture

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7826

showLinkedPage

showLinkedPage(model, triggerKey): void

Parameters

Parameter	Type
`model`	`BaseBlockModel`< `object` >
`triggerKey`	`string`

Returns

void

Defined In

packages/blocks/src/_common/widgets/linked-page/index.ts:101

showPopover

showPopover(): void

MDN Reference

Returns

void

Inherited from

WidgetElement.showPopover

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10093

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

Parameter	Type
`qualifiedName`	`string`
`force`?	`boolean`

Returns

boolean

Inherited from

WidgetElement.toggleAttribute

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7834

togglePopover

togglePopover(force?): void

MDN Reference

Parameters

Parameter	Type
`force`?	`boolean`

Returns

void

Inherited from

WidgetElement.togglePopover

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:10095

webkitMatchesSelector

webkitMatchesSelector(selectors): boolean

Parameters

Parameter	Type
`selectors`	`string`

Returns

boolean

Inherited from

WidgetElement.webkitMatchesSelector

Deprecated

This is a legacy alias of matches.

MDN Reference

Defined In

node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.dom.d.ts:7840

addInitializer

static 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);
  });
}

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;
}

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

Parameter	Type
`initializer`	`Initializer`

Returns

void

Inherited from

WidgetElement.addInitializer

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:257

finalize

protected static 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

Inherited from

WidgetElement.finalize

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:441

attributes

observedAttributes

static get observedAttributes(): string[]

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:346

Inherited from

WidgetElement.observedAttributes

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

Parameter	Type
`name`	`string`
`_old`	`null` \| `string`
`value`	`null` \| `string`

Returns

void

Inherited from

WidgetElement.attributeChangedCallback

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:580

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

Parameter	Type
`controller`	`ReactiveController`

Returns

void

Inherited from

WidgetElement.addController

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:519

removeController

removeController(controller): void

Removes a ReactiveController from the element.

Parameters

Parameter	Type
`controller`	`ReactiveController`

Returns

void

Inherited from

WidgetElement.removeController

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:524

dev-mode

disableWarning

static optional disableWarning: function

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');

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

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

Parameters

Parameter	Type
`warningKind`	`WarningKind`

Returns

void

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:223

Inherited from

WidgetElement.disableWarning

enableWarning

static optional enableWarning: function

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');

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

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

Parameters

Parameter	Type
`warningKind`	`WarningKind`

Returns

void

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:205

Inherited from

WidgetElement.enableWarning

enabledWarnings

static optional enabledWarnings: WarningKind[]

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

This property is only used in development builds.

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:187

Inherited from

WidgetElement.enabledWarnings

lifecycle

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);
}

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

An element may be re-connected after being disconnected.

Returns

void

Inherited from

WidgetElement.disconnectedCallback

Defined In

node_modules/.pnpm/lit-element@4.0.1/node_modules/lit-element/development/lit-element.d.ts:142

properties

elementProperties

static elementProperties: PropertyDeclarationMap

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

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:280

Inherited from

WidgetElement.elementProperties

properties

static 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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:306

Inherited from

WidgetElement.properties

createProperty

static 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);
}

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

Parameters

Parameter	Type
`name`	`PropertyKey`
`options`?	`PropertyDeclaration`< `unknown`, `unknown` >

Returns

void

Inherited from

WidgetElement.createProperty

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:373

getPropertyDescriptor

protected static 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
    }
  }
}

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

Parameter	Type
`name`	`PropertyKey`
`key`	`string` \| `symbol`
`options`	`PropertyDeclaration`< `unknown`, `unknown` >

Returns

undefined | PropertyDescriptor

Inherited from

WidgetElement.getPropertyDescriptor

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:401

getPropertyOptions

static 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

Parameter	Type
`name`	`PropertyKey`

Returns

PropertyDeclaration< unknown, unknown >

Inherited from

WidgetElement.getPropertyOptions

Nocollapse

Final

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:416

rendering

renderOptions

readonly renderOptions: RenderOptions

Defined In

node_modules/.pnpm/lit-element@4.0.1/node_modules/lit-element/development/lit-element.d.ts:88

Inherited from

WidgetElement.renderOptions

renderRoot

readonly renderRoot: HTMLElement | DocumentFragment

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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:473

Inherited from

WidgetElement.renderRoot

shadowRootOptions

static 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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:452

Inherited from

WidgetElement.shadowRootOptions

createRenderRoot

protected createRenderRoot(): HTMLElement | DocumentFragment

Returns

HTMLElement | DocumentFragment

Inherited from

WidgetElement.createRenderRoot

Defined In

node_modules/.pnpm/lit-element@4.0.1/node_modules/lit-element/development/lit-element.d.ts:93

styles

elementStyles

static elementStyles: CSSResultOrNative[]

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

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:313

Inherited from

WidgetElement.elementStyles

styles

static optional 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:

html

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

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

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:340

Inherited from

WidgetElement.styles

finalizeStyles

protected static 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

Parameter	Type
`styles`?	`CSSResultGroup`

Returns

CSSResultOrNative[]

Inherited from

WidgetElement.finalizeStyles

Nocollapse

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:467

updates

hasUpdated

hasUpdated: boolean

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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:491

Inherited from

WidgetElement.hasUpdated

isUpdatePending

isUpdatePending: boolean

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

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:485

Inherited from

WidgetElement.isUpdatePending

updateComplete

get updateComplete(): Promise< boolean >

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:671

Inherited from

WidgetElement.updateComplete

enableUpdating

protected 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

Parameter	Type
`_requestedUpdate`	`boolean`

Returns

void

Inherited from

WidgetElement.enableUpdating

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:560

firstUpdated

protected 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();
}

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

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

Parameters

Parameter	Type	Description
`_changedProperties`	`PropertyValueMap`< `any` > \| `Map`< `PropertyKey`, `unknown` >	Map of changed properties with old values

Returns

void

Inherited from

WidgetElement.firstUpdated

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:742

getUpdateComplete

protected 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;
  }
}

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

Returns

Promise< boolean >

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

Inherited from

WidgetElement.getUpdateComplete

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:695

performUpdate

protected 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

Inherited from

WidgetElement.performUpdate

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:631

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

Parameter	Type	Description
`name`?	`PropertyKey`	name of requesting property
`oldValue`?	`unknown`	old value of requesting property
`options`?	`PropertyDeclaration`< `unknown`, `unknown` >	property options to use instead of the previously configured options

Returns

void

Inherited from

WidgetElement.requestUpdate

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:598

scheduleUpdate

protected 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();
}

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

Returns

void | Promise< unknown >

Inherited from

WidgetElement.scheduleUpdate

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:620

shouldUpdate

protected 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

Parameter	Type	Description
`_changedProperties`	`PropertyValueMap`< `any` > \| `Map`< `PropertyKey`, `unknown` >	Map of changed properties with old values

Returns

boolean

Inherited from

WidgetElement.shouldUpdate

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:704

update

protected 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

Parameter	Type	Description
`changedProperties`	`PropertyValueMap`< `any` > \| `Map`< `PropertyKey`, `unknown` >	Map of changed properties with old values

Returns

void

Inherited from

WidgetElement.update

Defined In

node_modules/.pnpm/lit-element@4.0.1/node_modules/lit-element/development/lit-element.d.ts:101

updated

protected 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

Parameter	Type	Description
`_changedProperties`	`PropertyValueMap`< `any` > \| `Map`< `PropertyKey`, `unknown` >	Map of changed properties with old values

Returns

void

Inherited from

WidgetElement.updated

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:725

willUpdate

protected 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}`;
}

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

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

Parameters

Parameter	Type
`_changedProperties`	`PropertyValueMap`< `any` > \| `Map`< `PropertyKey`, `unknown` >

Returns

void

Inherited from

WidgetElement.willUpdate

Defined In

node_modules/.pnpm/@lit+reactive-element@2.0.1/node_modules/@lit/reactive-element/development/reactive-element.d.ts:653

Class: AffineLinkedPageWidget ​

Extends ​

Other ​

constructor ​

Returns ​

Inherited from ​

Defined In ​

ATTRIBUTE_NODE ​

Defined In ​

Inherited from ​

CDATA_SECTION_NODE ​

Defined In ​

Inherited from ​

COMMENT_NODE ​

Defined In ​

Inherited from ​

DOCUMENT_FRAGMENT_NODE ​

Defined In ​

Inherited from ​

DOCUMENT_NODE ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_CONTAINED_BY ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_CONTAINS ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_DISCONNECTED ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_FOLLOWING ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC ​

Defined In ​

Inherited from ​

DOCUMENT_POSITION_PRECEDING ​

Defined In ​

Inherited from ​

DOCUMENT_TYPE_NODE ​

Defined In ​

Inherited from ​

ELEMENT_NODE ​

Defined In ​

Inherited from ​

ENTITY_NODE ​

Defined In ​

Inherited from ​

ENTITY_REFERENCE_NODE ​

Defined In ​

Inherited from ​

NOTATION_NODE ​

Defined In ​

Inherited from ​

PROCESSING_INSTRUCTION_NODE ​

Defined In ​

Inherited from ​

TEXT_NODE ​

Defined In ​

Inherited from ​

_disposables ​

Defined In ​

Inherited from ​

accessKey ​

Defined In ​

Inherited from ​

accessKeyLabel ​

Defined In ​

Inherited from ​

ariaAtomic ​

Defined In ​

Inherited from ​

ariaAutoComplete ​

Defined In ​

Inherited from ​

ariaBusy ​

Defined In ​

Inherited from ​

ariaChecked ​

Class: AffineLinkedPageWidget

Extends

Other

constructor

Returns

Inherited from

Defined In

ATTRIBUTE_NODE

Defined In

Inherited from

CDATA_SECTION_NODE

Defined In

Inherited from

COMMENT_NODE

Defined In

Inherited from

DOCUMENT_FRAGMENT_NODE

Defined In

Inherited from

DOCUMENT_NODE

Defined In

Inherited from

DOCUMENT_POSITION_CONTAINED_BY

Defined In

Inherited from

DOCUMENT_POSITION_CONTAINS

Defined In

Inherited from

DOCUMENT_POSITION_DISCONNECTED

Defined In

Inherited from

DOCUMENT_POSITION_FOLLOWING

Defined In

Inherited from

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Defined In

Inherited from

DOCUMENT_POSITION_PRECEDING

Defined In

Inherited from

DOCUMENT_TYPE_NODE

Defined In

Inherited from

ELEMENT_NODE

Defined In

Inherited from

ENTITY_NODE

Defined In

Inherited from

ENTITY_REFERENCE_NODE

Defined In

Inherited from

NOTATION_NODE

Defined In

Inherited from

PROCESSING_INSTRUCTION_NODE

Defined In

Inherited from

TEXT_NODE

Defined In

Inherited from

_disposables

Defined In

Inherited from

accessKey

Defined In

Inherited from

accessKeyLabel

Defined In

Inherited from

ariaAtomic

Defined In

Inherited from

ariaAutoComplete

Defined In

Inherited from

ariaBusy

Defined In

Inherited from

ariaChecked