BlockSuite API Documentation / @blocksuite/block-std / WidgetComponent
Class: WidgetComponent<Model, B, S>
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:13
Extends
LitElement<this> &DisposableClass<this>
Extended by
AffineCodeToolbarWidgetAffineEdgelessZoomToolbarWidgetAffineFrameTitleWidgetAffineImageToolbarWidgetAffineInnerModalWidgetAffineKeyboardToolbarWidgetAffineLinkedDocWidgetAffineModalWidgetAffinePageDraggingAreaWidgetAffineSurfaceRefToolbarAffineViewportOverlayWidgetEdgelessElementToolbarWidgetAffineDragHandleWidgetEdgelessAutoConnectWidgetAffineFrameTitleWidgetAffineDocRemoteSelectionWidgetEdgelessRemoteSelectionWidgetAffineScrollAnchoringWidgetAffineToolbarWidget
Type Parameters
Model
Model extends BlockModel = BlockModel
B
B extends BlockComponent = BlockComponent
S
S extends BlockService = BlockService
Constructors
new WidgetComponent()
new WidgetComponent<
Model,B,S>():WidgetComponent<Model,B,S>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
Returns
WidgetComponent<Model, B, S>
Inherited from
SignalWatcher(WithDisposable(LitElement)).constructor
Other
_disposables
protected_disposables:DisposableGroup
Defined in: packages/framework/global/dist/lit/with-disposable.d.ts:5
Inherited from
SignalWatcher(WithDisposable(LitElement))._disposables
accessKey
accessKey:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10704
Inherited from
SignalWatcher(WithDisposable(LitElement)).accessKey
accessKeyLabel
readonlyaccessKeyLabel:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10706
Inherited from
SignalWatcher(WithDisposable(LitElement)).accessKeyLabel
ariaAtomic
ariaAtomic:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2466
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaAtomic
ariaAutoComplete
ariaAutoComplete:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2468
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaAutoComplete
ariaBrailleLabel
ariaBrailleLabel:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2470
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaBrailleLabel
ariaBrailleRoleDescription
ariaBrailleRoleDescription:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2472
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaBrailleRoleDescription
ariaBusy
ariaBusy:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2474
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaBusy
ariaChecked
ariaChecked:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2476
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaChecked
ariaColCount
ariaColCount:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2478
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaColCount
ariaColIndex
ariaColIndex:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2480
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaColIndex
ariaColIndexText
ariaColIndexText:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2482
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaColIndexText
ariaColSpan
ariaColSpan:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2484
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaColSpan
ariaCurrent
ariaCurrent:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2486
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaCurrent
ariaDescription
ariaDescription:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2488
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaDescription
ariaDisabled
ariaDisabled:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2490
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaDisabled
ariaExpanded
ariaExpanded:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2492
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaExpanded
ariaHasPopup
ariaHasPopup:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2494
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaHasPopup
ariaHidden
ariaHidden:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2496
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaHidden
ariaInvalid
ariaInvalid:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2497
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaInvalid
ariaKeyShortcuts
ariaKeyShortcuts:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2499
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaKeyShortcuts
ariaLabel
ariaLabel:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2501
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaLabel
ariaLevel
ariaLevel:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2503
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaLevel
ariaLive
ariaLive:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2505
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaLive
ariaModal
ariaModal:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2507
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaModal
ariaMultiLine
ariaMultiLine:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2509
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaMultiLine
ariaMultiSelectable
ariaMultiSelectable:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2511
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaMultiSelectable
ariaOrientation
ariaOrientation:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2513
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaOrientation
ariaPlaceholder
ariaPlaceholder:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2515
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaPlaceholder
ariaPosInSet
ariaPosInSet:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2517
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaPosInSet
ariaPressed
ariaPressed:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2519
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaPressed
ariaReadOnly
ariaReadOnly:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2521
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaReadOnly
ariaRelevant
ariaRelevant:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2523
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRelevant
ariaRequired
ariaRequired:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2525
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRequired
ariaRoleDescription
ariaRoleDescription:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2527
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRoleDescription
ariaRowCount
ariaRowCount:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2529
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRowCount
ariaRowIndex
ariaRowIndex:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2531
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRowIndex
ariaRowIndexText
ariaRowIndexText:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2533
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRowIndexText
ariaRowSpan
ariaRowSpan:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2535
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaRowSpan
ariaSelected
ariaSelected:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2537
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaSelected
ariaSetSize
ariaSetSize:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2539
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaSetSize
ariaSort
ariaSort:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2541
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaSort
ariaValueMax
ariaValueMax:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2543
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaValueMax
ariaValueMin
ariaValueMin:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2545
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaValueMin
ariaValueNow
ariaValueNow:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2547
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaValueNow
ariaValueText
ariaValueText:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2549
Inherited from
SignalWatcher(WithDisposable(LitElement)).ariaValueText
assignedSlot
readonlyassignedSlot:null|HTMLSlotElement
Defined in: node_modules/typescript/lib/lib.dom.d.ts:22553
Inherited from
SignalWatcher(WithDisposable(LitElement)).assignedSlot
ATTRIBUTE_NODE
readonlyATTRIBUTE_NODE:2
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17158
Inherited from
SignalWatcher(WithDisposable(LitElement)).ATTRIBUTE_NODE
attributes
readonlyattributes:NamedNodeMap
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8231
Inherited from
SignalWatcher(WithDisposable(LitElement)).attributes
attributeStyleMap
readonlyattributeStyleMap:StylePropertyMap
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8498
Inherited from
SignalWatcher(WithDisposable(LitElement)).attributeStyleMap
autocapitalize
autocapitalize:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10708
Inherited from
SignalWatcher(WithDisposable(LitElement)).autocapitalize
autofocus
autofocus:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12789
Inherited from
SignalWatcher(WithDisposable(LitElement)).autofocus
baseURI
readonlybaseURI:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17027
Returns node's node document's document base URL.
Inherited from
SignalWatcher(WithDisposable(LitElement)).baseURI
CDATA_SECTION_NODE
readonlyCDATA_SECTION_NODE:4
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17162
node is a CDATASection node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).CDATA_SECTION_NODE
childElementCount
readonlychildElementCount:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17745
Inherited from
SignalWatcher(WithDisposable(LitElement)).childElementCount
childNodes
readonlychildNodes:NodeListOf<ChildNode>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17033
Returns the children.
Inherited from
SignalWatcher(WithDisposable(LitElement)).childNodes
children
readonlychildren:HTMLCollection
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17751
Returns the child elements.
Inherited from
SignalWatcher(WithDisposable(LitElement)).children
className
className:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8244
Returns the value of element's class content attribute. Can be set to change it.
Inherited from
SignalWatcher(WithDisposable(LitElement)).className
clientHeight
readonlyclientHeight:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8246
Inherited from
SignalWatcher(WithDisposable(LitElement)).clientHeight
clientLeft
readonlyclientLeft:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8248
Inherited from
SignalWatcher(WithDisposable(LitElement)).clientLeft
clientTop
readonlyclientTop:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8250
Inherited from
SignalWatcher(WithDisposable(LitElement)).clientTop
clientWidth
readonlyclientWidth:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8252
Inherited from
SignalWatcher(WithDisposable(LitElement)).clientWidth
COMMENT_NODE
readonlyCOMMENT_NODE:8
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17168
node is a Comment node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).COMMENT_NODE
contentEditable
contentEditable:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8506
Inherited from
SignalWatcher(WithDisposable(LitElement)).contentEditable
currentCSSZoom
readonlycurrentCSSZoom:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8254
Inherited from
SignalWatcher(WithDisposable(LitElement)).currentCSSZoom
dataset
readonlydataset:DOMStringMap
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12791
Inherited from
SignalWatcher(WithDisposable(LitElement)).dataset
dir
dir:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10710
Inherited from
SignalWatcher(WithDisposable(LitElement)).dir
disposables
readonlydisposables:DisposableGroup
Defined in: packages/framework/global/dist/lit/with-disposable.d.ts:6
Inherited from
SignalWatcher(WithDisposable(LitElement)).disposables
DOCUMENT_FRAGMENT_NODE
readonlyDOCUMENT_FRAGMENT_NODE:11
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17174
node is a DocumentFragment node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_FRAGMENT_NODE
DOCUMENT_NODE
readonlyDOCUMENT_NODE:9
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17170
node is a document.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_NODE
DOCUMENT_POSITION_CONTAINED_BY
readonlyDOCUMENT_POSITION_CONTAINED_BY:16
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17185
Set when other is a descendant of node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_CONTAINS
readonlyDOCUMENT_POSITION_CONTAINS:8
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17183
Set when other is an ancestor of node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_DISCONNECTED
readonlyDOCUMENT_POSITION_DISCONNECTED:1
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17177
Set when node and other are not in the same tree.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_FOLLOWING
readonlyDOCUMENT_POSITION_FOLLOWING:4
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17181
Set when other is following node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:32
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17186
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_PRECEDING
readonlyDOCUMENT_POSITION_PRECEDING:2
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17179
Set when other is preceding node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_POSITION_PRECEDING
DOCUMENT_TYPE_NODE
readonlyDOCUMENT_TYPE_NODE:10
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17172
node is a doctype.
Inherited from
SignalWatcher(WithDisposable(LitElement)).DOCUMENT_TYPE_NODE
draggable
draggable:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10712
Inherited from
SignalWatcher(WithDisposable(LitElement)).draggable
ELEMENT_NODE
readonlyELEMENT_NODE:1
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17157
node is an element.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ELEMENT_NODE
enterKeyHint
enterKeyHint:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8508
Inherited from
SignalWatcher(WithDisposable(LitElement)).enterKeyHint
ENTITY_NODE
readonlyENTITY_NODE:6
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17164
Inherited from
SignalWatcher(WithDisposable(LitElement)).ENTITY_NODE
ENTITY_REFERENCE_NODE
readonlyENTITY_REFERENCE_NODE:5
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17163
Inherited from
SignalWatcher(WithDisposable(LitElement)).ENTITY_REFERENCE_NODE
firstChild
readonlyfirstChild:null|ChildNode
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17039
Returns the first child.
Inherited from
SignalWatcher(WithDisposable(LitElement)).firstChild
firstElementChild
readonlyfirstElementChild:null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17757
Returns the first child that is an element, and null otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).firstElementChild
hidden
hidden:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10714
Inherited from
SignalWatcher(WithDisposable(LitElement)).hidden
id
id:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8260
Returns the value of element's id content attribute. Can be set to change it.
Inherited from
SignalWatcher(WithDisposable(LitElement)).id
inert
inert:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10716
Inherited from
SignalWatcher(WithDisposable(LitElement)).inert
innerHTML
innerHTML:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8262
Inherited from
SignalWatcher(WithDisposable(LitElement)).innerHTML
innerText
innerText:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10718
Inherited from
SignalWatcher(WithDisposable(LitElement)).innerText
inputMode
inputMode:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8510
Inherited from
SignalWatcher(WithDisposable(LitElement)).inputMode
isConnected
readonlyisConnected:boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17045
Returns true if node is connected and false otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).isConnected
isContentEditable
readonlyisContentEditable:boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8512
Inherited from
SignalWatcher(WithDisposable(LitElement)).isContentEditable
lang
lang:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10720
Inherited from
SignalWatcher(WithDisposable(LitElement)).lang
lastChild
readonlylastChild:null|ChildNode
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17051
Returns the last child.
Inherited from
SignalWatcher(WithDisposable(LitElement)).lastChild
lastElementChild
readonlylastElementChild:null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17763
Returns the last child that is an element, and null otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).lastElementChild
localName
readonlylocalName:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8268
Returns the local name.
Inherited from
SignalWatcher(WithDisposable(LitElement)).localName
namespaceURI
readonlynamespaceURI:null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8274
Returns the namespace.
Inherited from
SignalWatcher(WithDisposable(LitElement)).namespaceURI
nextElementSibling
readonlynextElementSibling:null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17307
Returns the first following sibling that is an element, and null otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).nextElementSibling
nextSibling
readonlynextSibling:null|ChildNode
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17057
Returns the next sibling.
Inherited from
SignalWatcher(WithDisposable(LitElement)).nextSibling
nodeName
readonlynodeName:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17063
Returns a string appropriate for the type of node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).nodeName
nodeType
readonlynodeType:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17069
Returns the type of node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).nodeType
nodeValue
nodeValue:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17071
Inherited from
SignalWatcher(WithDisposable(LitElement)).nodeValue
nonce?
optionalnonce:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12793
Inherited from
SignalWatcher(WithDisposable(LitElement)).nonce
NOTATION_NODE
readonlyNOTATION_NODE:12
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17175
Inherited from
SignalWatcher(WithDisposable(LitElement)).NOTATION_NODE
offsetHeight
readonlyoffsetHeight:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10722
Inherited from
SignalWatcher(WithDisposable(LitElement)).offsetHeight
offsetLeft
readonlyoffsetLeft:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10724
Inherited from
SignalWatcher(WithDisposable(LitElement)).offsetLeft
offsetParent
readonlyoffsetParent:null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10726
Inherited from
SignalWatcher(WithDisposable(LitElement)).offsetParent
offsetTop
readonlyoffsetTop:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10728
Inherited from
SignalWatcher(WithDisposable(LitElement)).offsetTop
offsetWidth
readonlyoffsetWidth:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10730
Inherited from
SignalWatcher(WithDisposable(LitElement)).offsetWidth
onabort
onabort:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9625
Fires when the user aborts the download.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onabort
onanimationcancel
onanimationcancel:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9627
Inherited from
SignalWatcher(WithDisposable(LitElement)).onanimationcancel
onanimationend
onanimationend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9629
Inherited from
SignalWatcher(WithDisposable(LitElement)).onanimationend
onanimationiteration
onanimationiteration:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9631
Inherited from
SignalWatcher(WithDisposable(LitElement)).onanimationiteration
onanimationstart
onanimationstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9633
Inherited from
SignalWatcher(WithDisposable(LitElement)).onanimationstart
onauxclick
onauxclick:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9635
Inherited from
SignalWatcher(WithDisposable(LitElement)).onauxclick
onbeforeinput
onbeforeinput:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9637
Inherited from
SignalWatcher(WithDisposable(LitElement)).onbeforeinput
onbeforetoggle
onbeforetoggle:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9639
Inherited from
SignalWatcher(WithDisposable(LitElement)).onbeforetoggle
onblur
onblur:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9646
Fires when the object loses the input focus.
Param
The focus event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onblur
oncancel
oncancel:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9648
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncancel
oncanplay
oncanplay:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9655
Occurs when playback is possible, but would require further buffering.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncanplay
oncanplaythrough
oncanplaythrough:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9657
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncanplaythrough
onchange
onchange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9664
Fires when the contents of the object or selection have changed.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onchange
onclick
onclick:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9671
Fires when the user clicks the left mouse button on the object
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onclick
onclose
onclose:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9673
Inherited from
SignalWatcher(WithDisposable(LitElement)).onclose
oncontextlost
oncontextlost:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9675
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncontextlost
oncontextmenu
oncontextmenu:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9682
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncontextmenu
oncontextrestored
oncontextrestored:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9684
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncontextrestored
oncopy
oncopy:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9686
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncopy
oncuechange
oncuechange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9688
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncuechange
oncut
oncut:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9690
Inherited from
SignalWatcher(WithDisposable(LitElement)).oncut
ondblclick
ondblclick:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9697
Fires when the user double-clicks the object.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondblclick
ondrag
ondrag:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9704
Fires on the source object continuously during a drag operation.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondrag
ondragend
ondragend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9711
Fires on the source object when the user releases the mouse at the close of a drag operation.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondragend
ondragenter
ondragenter:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9718
Fires on the target element when the user drags the object to a valid drop target.
Param
The drag event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondragenter
ondragleave
ondragleave:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9725
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.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondragleave
ondragover
ondragover:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9732
Fires on the target element continuously while the user drags the object over a valid drop target.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondragover
ondragstart
ondragstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9739
Fires on the source object when the user starts to drag a text selection or selected object.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondragstart
ondrop
ondrop:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9741
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondrop
ondurationchange
ondurationchange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9748
Occurs when the duration attribute is updated.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ondurationchange
onemptied
onemptied:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9755
Occurs when the media element is reset to its initial state.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onemptied
onended
onended:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9762
Occurs when the end of playback is reached.
Param
The event
Inherited from
SignalWatcher(WithDisposable(LitElement)).onended
onerror
onerror:
OnErrorEventHandler
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9769
Fires when an error occurs during object loading.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onerror
onfocus
onfocus:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9776
Fires when the object receives focus.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onfocus
onformdata
onformdata:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9778
Inherited from
SignalWatcher(WithDisposable(LitElement)).onformdata
onfullscreenchange
onfullscreenchange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8276
Inherited from
SignalWatcher(WithDisposable(LitElement)).onfullscreenchange
onfullscreenerror
onfullscreenerror:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8278
Inherited from
SignalWatcher(WithDisposable(LitElement)).onfullscreenerror
ongotpointercapture
ongotpointercapture:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9780
Inherited from
SignalWatcher(WithDisposable(LitElement)).ongotpointercapture
oninput
oninput:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9782
Inherited from
SignalWatcher(WithDisposable(LitElement)).oninput
oninvalid
oninvalid:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9784
Inherited from
SignalWatcher(WithDisposable(LitElement)).oninvalid
onkeydown
onkeydown:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9791
Fires when the user presses a key.
Param
The keyboard event
Inherited from
SignalWatcher(WithDisposable(LitElement)).onkeydown
onkeypress
onkeypress:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9799
Fires when the user presses an alphanumeric key.
Param
The event.
Deprecated
Inherited from
SignalWatcher(WithDisposable(LitElement)).onkeypress
onkeyup
onkeyup:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9806
Fires when the user releases a key.
Param
The keyboard event
Inherited from
SignalWatcher(WithDisposable(LitElement)).onkeyup
onload
onload:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9813
Fires immediately after the browser loads the object.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onload
onloadeddata
onloadeddata:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9820
Occurs when media data is loaded at the current playback position.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onloadeddata
onloadedmetadata
onloadedmetadata:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9827
Occurs when the duration and dimensions of the media have been determined.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onloadedmetadata
onloadstart
onloadstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9834
Occurs when Internet Explorer begins looking for media data.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onloadstart
onlostpointercapture
onlostpointercapture:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9836
Inherited from
SignalWatcher(WithDisposable(LitElement)).onlostpointercapture
onmousedown
onmousedown:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9843
Fires when the user clicks the object with either mouse button.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmousedown
onmouseenter
onmouseenter:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9845
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmouseenter
onmouseleave
onmouseleave:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9847
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmouseleave
onmousemove
onmousemove:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9854
Fires when the user moves the mouse over the object.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmousemove
onmouseout
onmouseout:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9861
Fires when the user moves the mouse pointer outside the boundaries of the object.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmouseout
onmouseover
onmouseover:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9868
Fires when the user moves the mouse pointer into the object.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmouseover
onmouseup
onmouseup:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9875
Fires when the user releases a mouse button while the mouse is over the object.
Param
The mouse event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onmouseup
onpaste
onpaste:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9877
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpaste
onpause
onpause:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9884
Occurs when playback is paused.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpause
onplay
onplay:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9891
Occurs when the play method is requested.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onplay
onplaying
onplaying:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9898
Occurs when the audio or video has started playing.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onplaying
onpointercancel
onpointercancel:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9900
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointercancel
onpointerdown
onpointerdown:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9902
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerdown
onpointerenter
onpointerenter:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9904
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerenter
onpointerleave
onpointerleave:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9906
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerleave
onpointermove
onpointermove:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9908
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointermove
onpointerout
onpointerout:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9910
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerout
onpointerover
onpointerover:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9912
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerover
onpointerup
onpointerup:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9914
Inherited from
SignalWatcher(WithDisposable(LitElement)).onpointerup
onprogress
onprogress:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9921
Occurs to indicate progress while downloading media data.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onprogress
onratechange
onratechange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9928
Occurs when the playback rate is increased or decreased.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onratechange
onreset
onreset:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9935
Fires when the user resets a form.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onreset
onresize
onresize:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9937
Inherited from
SignalWatcher(WithDisposable(LitElement)).onresize
onscroll
onscroll:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9944
Fires when the user repositions the scroll box in the scroll bar on the object.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onscroll
onscrollend
onscrollend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9946
Inherited from
SignalWatcher(WithDisposable(LitElement)).onscrollend
onsecuritypolicyviolation
onsecuritypolicyviolation:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9948
Inherited from
SignalWatcher(WithDisposable(LitElement)).onsecuritypolicyviolation
onseeked
onseeked:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9955
Occurs when the seek operation ends.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onseeked
onseeking
onseeking:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9962
Occurs when the current playback position is moved.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onseeking
onselect
onselect:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9969
Fires when the current selection changes.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onselect
onselectionchange
onselectionchange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9971
Inherited from
SignalWatcher(WithDisposable(LitElement)).onselectionchange
onselectstart
onselectstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9973
Inherited from
SignalWatcher(WithDisposable(LitElement)).onselectstart
onslotchange
onslotchange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9975
Inherited from
SignalWatcher(WithDisposable(LitElement)).onslotchange
onstalled
onstalled:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9982
Occurs when the download has stopped.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onstalled
onsubmit
onsubmit:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9984
Inherited from
SignalWatcher(WithDisposable(LitElement)).onsubmit
onsuspend
onsuspend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9991
Occurs if the load operation has been intentionally halted.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onsuspend
ontimeupdate
ontimeupdate:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:9998
Occurs to indicate the current playback position.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontimeupdate
ontoggle
ontoggle:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10000
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontoggle
ontouchcancel?
optionalontouchcancel:null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10002
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontouchcancel
ontouchend?
optionalontouchend:null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10004
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontouchend
ontouchmove?
optionalontouchmove:null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10006
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontouchmove
ontouchstart?
optionalontouchstart:null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10008
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontouchstart
ontransitioncancel
ontransitioncancel:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10010
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontransitioncancel
ontransitionend
ontransitionend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10012
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontransitionend
ontransitionrun
ontransitionrun:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10014
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontransitionrun
ontransitionstart
ontransitionstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10016
Inherited from
SignalWatcher(WithDisposable(LitElement)).ontransitionstart
onvolumechange
onvolumechange:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10023
Occurs when the volume is changed, or playback is muted or unmuted.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onvolumechange
onwaiting
onwaiting:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10030
Occurs when playback stops because the next frame of a video resource is not available.
Param
The event.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwaiting
onwebkitanimationend
onwebkitanimationend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10036
Deprecated
This is a legacy alias of onanimationend.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwebkitanimationend
onwebkitanimationiteration
onwebkitanimationiteration:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10042
Deprecated
This is a legacy alias of onanimationiteration.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwebkitanimationiteration
onwebkitanimationstart
onwebkitanimationstart:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10048
Deprecated
This is a legacy alias of onanimationstart.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwebkitanimationstart
onwebkittransitionend
onwebkittransitionend:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10054
Deprecated
This is a legacy alias of ontransitionend.
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwebkittransitionend
onwheel
onwheel:
null| (this,ev) =>any
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10056
Inherited from
SignalWatcher(WithDisposable(LitElement)).onwheel
outerHTML
outerHTML:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8280
Inherited from
SignalWatcher(WithDisposable(LitElement)).outerHTML
outerText
outerText:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10732
Inherited from
SignalWatcher(WithDisposable(LitElement)).outerText
ownerDocument
readonlyownerDocument:Document
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8281
Returns the node document. Returns null for documents.
Inherited from
SignalWatcher(WithDisposable(LitElement)).ownerDocument
parentElement
readonlyparentElement:null|HTMLElement
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17083
Returns the parent element.
Inherited from
SignalWatcher(WithDisposable(LitElement)).parentElement
parentNode
readonlyparentNode:null|ParentNode
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17089
Returns the parent.
Inherited from
SignalWatcher(WithDisposable(LitElement)).parentNode
popover
popover:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10734
Inherited from
SignalWatcher(WithDisposable(LitElement)).popover
prefix
readonlyprefix:null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8290
Returns the namespace prefix.
Inherited from
SignalWatcher(WithDisposable(LitElement)).prefix
previousElementSibling
readonlypreviousElementSibling:null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17313
Returns the first preceding sibling that is an element, and null otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).previousElementSibling
previousSibling
readonlypreviousSibling:null|ChildNode
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17095
Returns the previous sibling.
Inherited from
SignalWatcher(WithDisposable(LitElement)).previousSibling
PROCESSING_INSTRUCTION_NODE
readonlyPROCESSING_INSTRUCTION_NODE:7
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17166
node is a ProcessingInstruction node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).PROCESSING_INSTRUCTION_NODE
role
role:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2550
Inherited from
SignalWatcher(WithDisposable(LitElement)).role
scrollHeight
readonlyscrollHeight:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8292
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollHeight
scrollLeft
scrollLeft:
number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8294
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollLeft
scrollTop
scrollTop:
number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8296
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollTop
scrollWidth
readonlyscrollWidth:number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8298
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollWidth
shadowRoot
readonlyshadowRoot:null|ShadowRoot
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8304
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Inherited from
SignalWatcher(WithDisposable(LitElement)).shadowRoot
slot
slot:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8310
Returns the value of element's slot content attribute. Can be set to change it.
Inherited from
SignalWatcher(WithDisposable(LitElement)).slot
spellcheck
spellcheck:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10736
Inherited from
SignalWatcher(WithDisposable(LitElement)).spellcheck
tabIndex
tabIndex:
number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12795
Inherited from
SignalWatcher(WithDisposable(LitElement)).tabIndex
tagName
readonlytagName:string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8316
Returns the HTML-uppercased qualified name.
Inherited from
SignalWatcher(WithDisposable(LitElement)).tagName
TEXT_NODE
readonlyTEXT_NODE:3
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17160
node is a Text node.
Inherited from
SignalWatcher(WithDisposable(LitElement)).TEXT_NODE
textContent
textContent:
null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17097
Inherited from
SignalWatcher(WithDisposable(LitElement)).textContent
title
title:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10738
Inherited from
SignalWatcher(WithDisposable(LitElement)).title
translate
translate:
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10740
Inherited from
SignalWatcher(WithDisposable(LitElement)).translate
writingSuggestions
writingSuggestions:
string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10742
Inherited from
SignalWatcher(WithDisposable(LitElement)).writingSuggestions
_$litElement$
static_$litElement$:boolean
Defined in: node_modules/lit-element/development/lit-element.d.ts:84
Inherited from
SignalWatcher(WithDisposable(LitElement))._$litElement$
_initializers?
staticoptional_initializers:Initializer[]
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:258
Inherited from
SignalWatcher(WithDisposable(LitElement))._initializers
[metadata]
static[metadata]:object&Record<PropertyKey,unknown>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:417
Inherited from
SignalWatcher(WithDisposable(LitElement)).[metadata]
finalized
protectedstaticfinalized:undefined|true
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:272
Marks class as having been finalized, which includes creating properties from static properties, but does not include all properties created from decorators.
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).finalized
block
Get Signature
get block():
B
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:30
Returns
B
classList
Get Signature
get classList():
DOMTokenList
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8237
Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns
DOMTokenList
Set Signature
set classList(
value):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8238
Parameters
value
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).classList
doc
Get Signature
get doc():
Store
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:34
Returns
flavour
Get Signature
get flavour():
string
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:38
Returns
string
host
Get Signature
get host():
EditorHost
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:42
Returns
model
Get Signature
get model():
Model
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:46
Returns
Model
part
Get Signature
get part():
DOMTokenList
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8283
Returns
DOMTokenList
Set Signature
set part(
value):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8284
Parameters
value
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).part
service
Get Signature
get service():
S
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:50
Returns
S
std
Get Signature
get std():
BlockStdScope
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:54
Returns
style
Get Signature
get style():
CSSStyleDeclaration
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8500
Returns
CSSStyleDeclaration
Set Signature
set style(
cssText):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8501
Parameters
cssText
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).style
widgetId
Get Signature
get widgetId():
string
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:58
Returns
string
addEventListener()
Call Signature
addEventListener<
K>(type,listener,options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10753
Type Parameters
K
K extends keyof HTMLElementEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).addEventListener
Call Signature
addEventListener(
type,listener,options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10754
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | AddEventListenerOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).addEventListener
after()
after(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:6167
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).after
animate()
animate(
keyframes,options?):Animation
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2702
Parameters
keyframes
null | Keyframe[] | PropertyIndexedKeyframes
options?
number | KeyframeAnimationOptions
Returns
Animation
Inherited from
SignalWatcher(WithDisposable(LitElement)).animate
append()
append(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17771
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).append
appendChild()
appendChild<
T>(node):T
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17099
Type Parameters
T
T extends Node
Parameters
node
T
Returns
T
Inherited from
SignalWatcher(WithDisposable(LitElement)).appendChild
attachInternals()
attachInternals():
ElementInternals
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10744
Returns
ElementInternals
Inherited from
SignalWatcher(WithDisposable(LitElement)).attachInternals
attachShadow()
attachShadow(
init):ShadowRoot
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8322
Creates a shadow root for element and returns it.
Parameters
init
ShadowRootInit
Returns
ShadowRoot
Inherited from
SignalWatcher(WithDisposable(LitElement)).attachShadow
before()
before(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:6175
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).before
bindHotKey()
bindHotKey(
keymap,options?):void
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:62
Parameters
keymap
Record<string, UIEventHandler>
options?
global
boolean
Returns
void
blur()
blur():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12797
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).blur
checkVisibility()
checkVisibility(
options?):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8324
Parameters
options?
CheckVisibilityOptions
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).checkVisibility
click()
click():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10746
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).click
cloneNode()
cloneNode(
subtree?):Node
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17105
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Parameters
subtree?
boolean
Returns
Node
Inherited from
SignalWatcher(WithDisposable(LitElement)).cloneNode
closest()
Call Signature
closest<
K>(selector):null|HTMLElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8330
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selector
K
Returns
null | HTMLElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).closest
Call Signature
closest<
K>(selector):null|SVGElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8331
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selector
K
Returns
null | SVGElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).closest
Call Signature
closest<
K>(selector):null|MathMLElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8332
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selector
K
Returns
null | MathMLElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).closest
Call Signature
closest<
E>(selectors):null|E
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8333
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
null | E
Inherited from
SignalWatcher(WithDisposable(LitElement)).closest
compareDocumentPosition()
compareDocumentPosition(
other):number
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17111
Returns a bitmask indicating the position of other relative to node.
Parameters
other
Node
Returns
number
Inherited from
SignalWatcher(WithDisposable(LitElement)).compareDocumentPosition
computedStyleMap()
computedStyleMap():
StylePropertyMapReadOnly
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8335
Returns
StylePropertyMapReadOnly
Inherited from
SignalWatcher(WithDisposable(LitElement)).computedStyleMap
contains()
contains(
other):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17117
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
other
null | Node
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).contains
dispatchEvent()
dispatchEvent(
event):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8882
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.
Parameters
event
Event
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).dispatchEvent
focus()
focus(
options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:12799
Parameters
options?
FocusOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).focus
getAnimations()
getAnimations(
options?):Animation[]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:2704
Parameters
options?
GetAnimationsOptions
Returns
Animation[]
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAnimations
getAttribute()
getAttribute(
qualifiedName):null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8341
Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.
Parameters
qualifiedName
string
Returns
null | string
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAttribute
getAttributeNames()
getAttributeNames():
string[]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8353
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns
string[]
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAttributeNames
getAttributeNode()
getAttributeNode(
qualifiedName):null|Attr
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8355
Parameters
qualifiedName
string
Returns
null | Attr
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAttributeNode
getAttributeNodeNS()
getAttributeNodeNS(
namespace,localName):null|Attr
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8357
Parameters
namespace
null | string
localName
string
Returns
null | Attr
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAttributeNodeNS
getAttributeNS()
getAttributeNS(
namespace,localName):null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8347
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Parameters
namespace
null | string
localName
string
Returns
null | string
Inherited from
SignalWatcher(WithDisposable(LitElement)).getAttributeNS
getBoundingClientRect()
getBoundingClientRect():
DOMRect
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8359
Returns
DOMRect
Inherited from
SignalWatcher(WithDisposable(LitElement)).getBoundingClientRect
getClientRects()
getClientRects():
DOMRectList
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8361
Returns
DOMRectList
Inherited from
SignalWatcher(WithDisposable(LitElement)).getClientRects
getElementsByClassName()
getElementsByClassName(
classNames):HTMLCollectionOf<Element>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8367
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.
Parameters
classNames
string
Returns
HTMLCollectionOf<Element>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByClassName
getElementsByTagName()
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<HTMLElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8369
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagName
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<SVGElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8370
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagName
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<MathMLElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8371
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagName
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8373
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
qualifiedName
K
Returns
HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagName
Call Signature
getElementsByTagName(
qualifiedName):HTMLCollectionOf<Element>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8374
Parameters
qualifiedName
string
Returns
HTMLCollectionOf<Element>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagName
getElementsByTagNameNS()
Call Signature
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<HTMLElement>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8376
Parameters
namespaceURI
"http://www.w3.org/1999/xhtml"
localName
string
Returns
HTMLCollectionOf<HTMLElement>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagNameNS
Call Signature
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<SVGElement>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8377
Parameters
namespaceURI
"http://www.w3.org/2000/svg"
localName
string
Returns
HTMLCollectionOf<SVGElement>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagNameNS
Call Signature
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<MathMLElement>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8378
Parameters
namespaceURI
"http://www.w3.org/1998/Math/MathML"
localName
string
Returns
HTMLCollectionOf<MathMLElement>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagNameNS
Call Signature
getElementsByTagNameNS(
namespace,localName):HTMLCollectionOf<Element>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8379
Parameters
namespace
null | string
localName
string
Returns
HTMLCollectionOf<Element>
Inherited from
SignalWatcher(WithDisposable(LitElement)).getElementsByTagNameNS
getHTML()
getHTML(
options?):string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8381
Parameters
options?
GetHTMLOptions
Returns
string
Inherited from
SignalWatcher(WithDisposable(LitElement)).getHTML
getRootNode()
getRootNode(
options?):Node
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17123
Returns node's root.
Parameters
options?
GetRootNodeOptions
Returns
Node
Inherited from
SignalWatcher(WithDisposable(LitElement)).getRootNode
handleEvent()
handleEvent(
name,handler,options?):void
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:18
Parameters
name
"copy" | "blur" | "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "nativeDragOver" | "nativeDragLeave" | "beforeInput" | "focus" | "contextMenu" | "wheel"
handler
options?
global?
boolean
Returns
void
hasAttribute()
hasAttribute(
qualifiedName):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8387
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Parameters
qualifiedName
string
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasAttribute
hasAttributeNS()
hasAttributeNS(
namespace,localName):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8393
Returns true if element has an attribute whose namespace is namespace and local name is localName.
Parameters
namespace
null | string
localName
string
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasAttributeNS
hasAttributes()
hasAttributes():
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8399
Returns true if element has attributes, and false otherwise.
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasAttributes
hasChildNodes()
hasChildNodes():
boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17129
Returns whether node has children.
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasChildNodes
hasPointerCapture()
hasPointerCapture(
pointerId):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8401
Parameters
pointerId
number
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasPointerCapture
hidePopover()
hidePopover():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10748
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).hidePopover
insertAdjacentElement()
insertAdjacentElement(
where,element):null|Element
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8403
Parameters
where
InsertPosition
element
Element
Returns
null | Element
Inherited from
SignalWatcher(WithDisposable(LitElement)).insertAdjacentElement
insertAdjacentHTML()
insertAdjacentHTML(
position,string):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8405
Parameters
position
InsertPosition
string
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).insertAdjacentHTML
insertAdjacentText()
insertAdjacentText(
where,data):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8407
Parameters
where
InsertPosition
data
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).insertAdjacentText
insertBefore()
insertBefore<
T>(node,child):T
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17131
Type Parameters
T
T extends Node
Parameters
node
T
child
null | Node
Returns
T
Inherited from
SignalWatcher(WithDisposable(LitElement)).insertBefore
isDefaultNamespace()
isDefaultNamespace(
namespace):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17133
Parameters
namespace
null | string
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).isDefaultNamespace
isEqualNode()
isEqualNode(
otherNode):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17139
Returns whether node and otherNode have the same properties.
Parameters
otherNode
null | Node
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).isEqualNode
isSameNode()
isSameNode(
otherNode):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17141
Parameters
otherNode
null | Node
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).isSameNode
lookupNamespaceURI()
lookupNamespaceURI(
prefix):null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17143
Parameters
prefix
null | string
Returns
null | string
Inherited from
SignalWatcher(WithDisposable(LitElement)).lookupNamespaceURI
lookupPrefix()
lookupPrefix(
namespace):null|string
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17145
Parameters
namespace
null | string
Returns
null | string
Inherited from
SignalWatcher(WithDisposable(LitElement)).lookupPrefix
matches()
matches(
selectors):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8413
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
selectors
string
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).matches
normalize()
normalize():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17151
Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).normalize
prepend()
prepend(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17779
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).prepend
querySelector()
Call Signature
querySelector<
K>(selectors):null|HTMLElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17785
Returns the first element that is a descendant of node that matches selectors.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selectors
K
Returns
null | HTMLElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelector
Call Signature
querySelector<
K>(selectors):null|SVGElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17786
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selectors
K
Returns
null | SVGElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelector
Call Signature
querySelector<
K>(selectors):null|MathMLElementTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17787
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selectors
K
Returns
null | MathMLElementTagNameMap[K]
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelector
Call Signature
querySelector<
K>(selectors):null|HTMLElementDeprecatedTagNameMap[K]
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17789
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
selectors
K
Returns
null | HTMLElementDeprecatedTagNameMap[K]
Deprecated
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelector
Call Signature
querySelector<
E>(selectors):null|E
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17790
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
null | E
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelector
querySelectorAll()
Call Signature
querySelectorAll<
K>(selectors):NodeListOf<HTMLElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17796
Returns all element descendants of node that match selectors.
Type Parameters
K
K extends keyof HTMLElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<HTMLElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelectorAll
Call Signature
querySelectorAll<
K>(selectors):NodeListOf<SVGElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17797
Type Parameters
K
K extends keyof SVGElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<SVGElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelectorAll
Call Signature
querySelectorAll<
K>(selectors):NodeListOf<MathMLElementTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17798
Type Parameters
K
K extends keyof MathMLElementTagNameMap
Parameters
selectors
K
Returns
NodeListOf<MathMLElementTagNameMap[K]>
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelectorAll
Call Signature
querySelectorAll<
K>(selectors):NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17800
Type Parameters
K
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
selectors
K
Returns
NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelectorAll
Call Signature
querySelectorAll<
E>(selectors):NodeListOf<E>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17801
Type Parameters
E
E extends Element = Element
Parameters
selectors
string
Returns
NodeListOf<E>
Inherited from
SignalWatcher(WithDisposable(LitElement)).querySelectorAll
releasePointerCapture()
releasePointerCapture(
pointerId):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8415
Parameters
pointerId
number
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).releasePointerCapture
remove()
remove():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:6181
Removes node.
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).remove
removeAttribute()
removeAttribute(
qualifiedName):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8421
Removes element's first attribute whose qualified name is qualifiedName.
Parameters
qualifiedName
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeAttribute
removeAttributeNode()
removeAttributeNode(
attr):Attr
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8429
Parameters
attr
Attr
Returns
Attr
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeAttributeNode
removeAttributeNS()
removeAttributeNS(
namespace,localName):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8427
Removes element's attribute whose namespace is namespace and local name is localName.
Parameters
namespace
null | string
localName
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeAttributeNS
removeChild()
removeChild<
T>(child):T
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17153
Type Parameters
T
T extends Node
Parameters
child
T
Returns
T
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeChild
removeEventListener()
Call Signature
removeEventListener<
K>(type,listener,options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10755
Type Parameters
K
K extends keyof HTMLElementEventMap
Parameters
type
K
listener
(this, ev) => any
options?
boolean | EventListenerOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeEventListener
Call Signature
removeEventListener(
type,listener,options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10756
Parameters
type
string
listener
EventListenerOrEventListenerObject
options?
boolean | EventListenerOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeEventListener
replaceChild()
replaceChild<
T>(node,child):T
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17155
Type Parameters
T
T extends Node
Parameters
node
Node
child
T
Returns
T
Inherited from
SignalWatcher(WithDisposable(LitElement)).replaceChild
replaceChildren()
replaceChildren(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:17809
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).replaceChildren
replaceWith()
replaceWith(...
nodes):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:6189
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
nodes
...(string | Node)[]
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).replaceWith
requestFullscreen()
requestFullscreen(
options?):Promise<void>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8437
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.
Parameters
options?
FullscreenOptions
Returns
Promise<void>
Inherited from
SignalWatcher(WithDisposable(LitElement)).requestFullscreen
requestPointerLock()
requestPointerLock(
options?):Promise<void>
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8439
Parameters
options?
PointerLockOptions
Returns
Promise<void>
Inherited from
SignalWatcher(WithDisposable(LitElement)).requestPointerLock
scroll()
Call Signature
scroll(
options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8441
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scroll
Call Signature
scroll(
x,y):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8442
Parameters
x
number
y
number
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scroll
scrollBy()
Call Signature
scrollBy(
options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8444
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollBy
Call Signature
scrollBy(
x,y):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8445
Parameters
x
number
y
number
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollBy
scrollIntoView()
scrollIntoView(
arg?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8447
Parameters
arg?
boolean | ScrollIntoViewOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollIntoView
scrollTo()
Call Signature
scrollTo(
options?):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8449
Parameters
options?
ScrollToOptions
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollTo
Call Signature
scrollTo(
x,y):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8450
Parameters
x
number
y
number
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).scrollTo
setAttribute()
setAttribute(
qualifiedName,value):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8456
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Parameters
qualifiedName
string
value
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).setAttribute
setAttributeNode()
setAttributeNode(
attr):null|Attr
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8464
Parameters
attr
Attr
Returns
null | Attr
Inherited from
SignalWatcher(WithDisposable(LitElement)).setAttributeNode
setAttributeNodeNS()
setAttributeNodeNS(
attr):null|Attr
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8466
Parameters
attr
Attr
Returns
null | Attr
Inherited from
SignalWatcher(WithDisposable(LitElement)).setAttributeNodeNS
setAttributeNS()
setAttributeNS(
namespace,qualifiedName,value):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8462
Sets the value of element's attribute whose namespace is namespace and local name is localName to value.
Parameters
namespace
null | string
qualifiedName
string
value
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).setAttributeNS
setHTMLUnsafe()
setHTMLUnsafe(
html):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8468
Parameters
html
string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).setHTMLUnsafe
setPointerCapture()
setPointerCapture(
pointerId):void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8470
Parameters
pointerId
number
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).setPointerCapture
showPopover()
showPopover():
void
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10750
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).showPopover
toggleAttribute()
toggleAttribute(
qualifiedName,force?):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8478
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.
Parameters
qualifiedName
string
force?
boolean
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).toggleAttribute
togglePopover()
togglePopover(
options?):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:10752
Parameters
options?
boolean
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).togglePopover
webkitMatchesSelector()
webkitMatchesSelector(
selectors):boolean
Defined in: node_modules/typescript/lib/lib.dom.d.ts:8484
Parameters
selectors
string
Returns
boolean
Deprecated
This is a legacy alias of matches.
Inherited from
SignalWatcher(WithDisposable(LitElement)).webkitMatchesSelector
addInitializer()
staticaddInitializer(initializer):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:257
Adds an initializer function to the class that is called during instance construction.
This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.
const myDecorator = (target: typeof ReactiveElement, key: string) => {
target.addInitializer((instance: ReactiveElement) => {
// This is run during construction of the element
new MyController(instance);
});
}Decorating a field will then cause each instance to run an initializer that adds a controller:
class MyElement extends LitElement {
@myDecorator foo;
}Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.
Parameters
initializer
Initializer
Returns
void
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).addInitializer
finalize()
protectedstaticfinalize():void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:441
Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.
This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.
Returns
void
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).finalize
attributes
observedAttributes
Get Signature
get
staticobservedAttributes():string[]
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:346
Returns a list of attributes corresponding to the registered properties.
Nocollapse
Returns
string[]
Inherited from
SignalWatcher(WithDisposable(LitElement)).observedAttributes
attributeChangedCallback()
attributeChangedCallback(
name,_old,value):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:580
Synchronizes property values when attributes change.
Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.
See using the lifecycle callbacks on MDN for more information about the attributeChangedCallback.
Parameters
name
string
_old
null | string
value
null | string
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).attributeChangedCallback
controllers
addController()
addController(
controller):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:519
Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.
If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.
Parameters
controller
ReactiveController
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).addController
removeController()
removeController(
controller):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:524
Removes a ReactiveController from the element.
Parameters
controller
ReactiveController
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).removeController
dev-mode
disableWarning()?
staticoptionaldisableWarning: (warningKind) =>void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:223
Disable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');
// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');Parameters
warningKind
WarningKind
Returns
void
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).disableWarning
enabledWarnings?
staticoptionalenabledWarnings:WarningKind[]
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:187
Read or set all the enabled warning categories for this class.
This property is only used in development builds.
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).enabledWarnings
enableWarning()?
staticoptionalenableWarning: (warningKind) =>void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:205
Enable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');
// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');Parameters
warningKind
WarningKind
Returns
void
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).enableWarning
lifecycle
connectedCallback()
connectedCallback():
void
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:73
Invoked when the component is added to the document's DOM.
In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.
connectedCallback() {
super.connectedCallback();
addEventListener('keydown', this._handleKeydown);
}Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().
Returns
void
Overrides
SignalWatcher(WithDisposable(LitElement)).connectedCallback
disconnectedCallback()
disconnectedCallback():
void
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:83
Invoked when the component is removed from the document's DOM.
This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.
disconnectedCallback() {
super.disconnectedCallback();
window.removeEventListener('keydown', this._handleKeydown);
}An element may be re-connected after being disconnected.
Returns
void
Overrides
SignalWatcher(WithDisposable(LitElement)).disconnectedCallback
properties
elementProperties
staticelementProperties:PropertyDeclarationMap
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:280
Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).elementProperties
properties
staticproperties:PropertyDeclarations
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:306
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
Inherited from
SignalWatcher(WithDisposable(LitElement)).properties
createProperty()
staticcreateProperty(name,options?):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:373
Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.
This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:
static createProperty(name, options) {
options = Object.assign(options, {myOption: true});
super.createProperty(name, options);
}Parameters
name
PropertyKey
options?
PropertyDeclaration<unknown, unknown>
Returns
void
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).createProperty
getPropertyDescriptor()
protectedstaticgetPropertyDescriptor(name,key,options):undefined|PropertyDescriptor
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:401
Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,
class MyElement extends LitElement {
static getPropertyDescriptor(name, key, options) {
const defaultDescriptor =
super.getPropertyDescriptor(name, key, options);
const setter = defaultDescriptor.set;
return {
get: defaultDescriptor.get,
set(value) {
setter.call(this, value);
// custom action.
},
configurable: true,
enumerable: true
}
}
}Parameters
name
PropertyKey
key
string | symbol
options
PropertyDeclaration
Returns
undefined | PropertyDescriptor
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).getPropertyDescriptor
getPropertyOptions()
staticgetPropertyOptions(name):PropertyDeclaration<unknown,unknown>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:416
Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).
Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.
Parameters
name
PropertyKey
Returns
PropertyDeclaration<unknown, unknown>
Nocollapse
Final
Inherited from
SignalWatcher(WithDisposable(LitElement)).getPropertyOptions
rendering
renderOptions
readonlyrenderOptions:RenderOptions
Defined in: node_modules/lit-element/development/lit-element.d.ts:88
Inherited from
SignalWatcher(WithDisposable(LitElement)).renderOptions
renderRoot
readonlyrenderRoot:HTMLElement|DocumentFragment
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:473
Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
Inherited from
SignalWatcher(WithDisposable(LitElement)).renderRoot
shadowRootOptions
staticshadowRootOptions:ShadowRootInit
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:452
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
Inherited from
SignalWatcher(WithDisposable(LitElement)).shadowRootOptions
createRenderRoot()
protectedcreateRenderRoot():HTMLElement|DocumentFragment
Defined in: node_modules/lit-element/development/lit-element.d.ts:93
Returns
HTMLElement | DocumentFragment
Inherited from
SignalWatcher(WithDisposable(LitElement)).createRenderRoot
render()
render():
unknown
Defined in: packages/framework/block-std/src/view/element/widget-component.ts:92
Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.
Returns
unknown
Overrides
SignalWatcher(WithDisposable(LitElement)).render
styles
elementStyles
staticelementStyles:CSSResultOrNative[]
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:313
Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).elementStyles
styles?
staticoptionalstyles:CSSResultGroup
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:340
Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.
Note on Content Security Policy:
Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.
To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:
<script>
// Generated and unique per request:
window.litNonce = 'a1b2c3d4';
</script>Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).styles
finalizeStyles()
protectedstaticfinalizeStyles(styles?):CSSResultOrNative[]
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:467
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
styles?
CSSResultGroup
Returns
CSSResultOrNative[]
Nocollapse
Inherited from
SignalWatcher(WithDisposable(LitElement)).finalizeStyles
updates
hasUpdated
hasUpdated:
boolean
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:491
Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.
Inherited from
SignalWatcher(WithDisposable(LitElement)).hasUpdated
isUpdatePending
isUpdatePending:
boolean
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:485
True if there is a pending update as a result of calling requestUpdate(). Should only be read.
Inherited from
SignalWatcher(WithDisposable(LitElement)).isUpdatePending
updateComplete
Get Signature
get updateComplete():
Promise<boolean>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:669
Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.
To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.
Returns
Promise<boolean>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Inherited from
SignalWatcher(WithDisposable(LitElement)).updateComplete
enableUpdating()
protectedenableUpdating(_requestedUpdate):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:560
Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.
Parameters
_requestedUpdate
boolean
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).enableUpdating
firstUpdated()
protectedfirstUpdated(_changedProperties):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:740
Invoked when the element is first updated. Implement to perform one time work on the element after update.
firstUpdated() {
this.renderRoot.getElementById('my-text-area').focus();
}Setting properties inside this method will trigger the element to update again after this update cycle completes.
Parameters
_changedProperties
Map of changed properties with old values
PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).firstUpdated
getUpdateComplete()
protectedgetUpdateComplete():Promise<boolean>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:693
Override point for the updateComplete promise.
It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:
class MyElement extends LitElement {
override async getUpdateComplete() {
const result = await super.getUpdateComplete();
await this._myChild.updateComplete;
return result;
}
}Returns
Promise<boolean>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Inherited from
SignalWatcher(WithDisposable(LitElement)).getUpdateComplete
performUpdate()
protectedperformUpdate():void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:629
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
SignalWatcher(WithDisposable(LitElement)).performUpdate
requestUpdate()
requestUpdate(
name?,oldValue?,options?):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:596
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
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
SignalWatcher(WithDisposable(LitElement)).requestUpdate
scheduleUpdate()
protectedscheduleUpdate():void|Promise<unknown>
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:618
Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.
For instance, to schedule updates to occur just before the next frame:
override protected async scheduleUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.scheduleUpdate();
}Returns
void | Promise<unknown>
Inherited from
SignalWatcher(WithDisposable(LitElement)).scheduleUpdate
shouldUpdate()
protectedshouldUpdate(_changedProperties):boolean
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:702
Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.
Parameters
_changedProperties
Map of changed properties with old values
PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
boolean
Inherited from
SignalWatcher(WithDisposable(LitElement)).shouldUpdate
update()
protectedupdate(changedProperties):void
Defined in: node_modules/lit-element/development/lit-element.d.ts:101
Updates the element. This method reflects property values to attributes and calls render to render DOM via lit-html. Setting properties inside this method will not trigger another update.
Parameters
changedProperties
Map of changed properties with old values
PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).update
updated()
protectedupdated(_changedProperties):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:723
Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Parameters
_changedProperties
Map of changed properties with old values
PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).updated
willUpdate()
protectedwillUpdate(_changedProperties):void
Defined in: node_modules/@lit/reactive-element/development/reactive-element.d.ts:651
Invoked before update() to compute values needed during the update.
Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.
willUpdate(changedProperties) {
// only need to check changed properties for an expensive computation.
if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
}
}
render() {
return html`SHA: ${this.sha}`;
}Parameters
_changedProperties
PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
SignalWatcher(WithDisposable(LitElement)).willUpdate