BlockSuite API Documentation / @blocksuite/blocks / CodeBlockComponent
Class: CodeBlockComponent
Extends
Other
new CodeBlockComponent(undefined)
new CodeBlockComponent():
CodeBlockComponent
Returns
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504
ATTRIBUTE_NODE
readonlyATTRIBUTE_NODE:2
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16315
CDATA_SECTION_NODE
readonlyCDATA_SECTION_NODE:4
node is a CDATASection node.
Inherited from
BlockElement.CDATA_SECTION_NODE
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16319
COMMENT_NODE
readonlyCOMMENT_NODE:8
node is a Comment node.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16325
DOCUMENT_FRAGMENT_NODE
readonlyDOCUMENT_FRAGMENT_NODE:11
node is a DocumentFragment node.
Inherited from
BlockElement.DOCUMENT_FRAGMENT_NODE
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16331
DOCUMENT_NODE
readonlyDOCUMENT_NODE:9
node is a document.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16327
DOCUMENT_POSITION_CONTAINED_BY
readonlyDOCUMENT_POSITION_CONTAINED_BY:16
Set when other is a descendant of node.
Inherited from
BlockElement.DOCUMENT_POSITION_CONTAINED_BY
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16342
DOCUMENT_POSITION_CONTAINS
readonlyDOCUMENT_POSITION_CONTAINS:8
Set when other is an ancestor of node.
Inherited from
BlockElement.DOCUMENT_POSITION_CONTAINS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16340
DOCUMENT_POSITION_DISCONNECTED
readonlyDOCUMENT_POSITION_DISCONNECTED:1
Set when node and other are not in the same tree.
Inherited from
BlockElement.DOCUMENT_POSITION_DISCONNECTED
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16334
DOCUMENT_POSITION_FOLLOWING
readonlyDOCUMENT_POSITION_FOLLOWING:4
Set when other is following node.
Inherited from
BlockElement.DOCUMENT_POSITION_FOLLOWING
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16338
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:32
Inherited from
BlockElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16343
DOCUMENT_POSITION_PRECEDING
readonlyDOCUMENT_POSITION_PRECEDING:2
Set when other is preceding node.
Inherited from
BlockElement.DOCUMENT_POSITION_PRECEDING
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16336
DOCUMENT_TYPE_NODE
readonlyDOCUMENT_TYPE_NODE:10
node is a doctype.
Inherited from
BlockElement.DOCUMENT_TYPE_NODE
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16329
ELEMENT_NODE
readonlyELEMENT_NODE:1
node is an element.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16314
ENTITY_NODE
readonlyENTITY_NODE:6
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16321
ENTITY_REFERENCE_NODE
readonlyENTITY_REFERENCE_NODE:5
Inherited from
BlockElement.ENTITY_REFERENCE_NODE
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16320
NOTATION_NODE
readonlyNOTATION_NODE:12
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16332
PROCESSING_INSTRUCTION_NODE
readonlyPROCESSING_INSTRUCTION_NODE:7
node is a ProcessingInstruction node.
Inherited from
BlockElement.PROCESSING_INSTRUCTION_NODE
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16323
TEXT_NODE
readonlyTEXT_NODE:3
node is a Text node.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16317
_disposables
protected_disposables:DisposableGroup
Inherited from
Source
packages/framework/lit/dist/with-disposable.d.ts:5
_highlighter
private_highlighter:null|Highlighter=null
Source
packages/blocks/src/code-block/code-block.ts:188
_inlineRangeProvider
private_inlineRangeProvider:null|InlineRangeProvider=null
Source
packages/blocks/src/code-block/code-block.ts:222
_langButton
private_langButton:HTMLButtonElement
Source
packages/blocks/src/code-block/code-block.ts:137
_langListAbortController?
privateoptional_langListAbortController:AbortController
Source
packages/blocks/src/code-block/code-block.ts:140
_perviousLanguage
private_perviousLanguage:StrictLanguageInfo=PLAIN_TEXT_LANG_INFO
Given the high cost associated with updating the highlight, it is preferable to do so only when a change in language occurs.
The variable is used to store the "current" language info, also known as the "previous" language when a language change occurs and the highlighter is not updated.
In most cases, the language will be equal to normalizing the language of the model.
See updated
Source
packages/blocks/src/code-block/code-block.ts:187
_richTextElement?
privateoptional_richTextElement:RichText
Source
packages/blocks/src/code-block/code-block.ts:235
_richTextResizeObserver
private_richTextResizeObserver:ResizeObserver
Source
packages/blocks/src/code-block/code-block.ts:171
_whenHover
private_whenHover:HoverController
Source
packages/blocks/src/code-block/code-block.ts:237
_wrap
private_wrap:boolean=false
Source
packages/blocks/src/code-block/code-block.ts:134
accessKey
accessKey:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10102
accessKeyLabel
readonlyaccessKeyLabel:string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10104
ariaAtomic
ariaAtomic:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2207
ariaAutoComplete
ariaAutoComplete:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2209
ariaBusy
ariaBusy:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2211
ariaChecked
ariaChecked:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2213
ariaColCount
ariaColCount:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2215
ariaColIndex
ariaColIndex:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2217
ariaColSpan
ariaColSpan:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2219
ariaCurrent
ariaCurrent:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2221
ariaDescription
ariaDescription:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2223
ariaDisabled
ariaDisabled:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2225
ariaExpanded
ariaExpanded:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2227
ariaHasPopup
ariaHasPopup:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2229
ariaHidden
ariaHidden:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2231
ariaInvalid
ariaInvalid:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2232
ariaKeyShortcuts
ariaKeyShortcuts:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2234
ariaLabel
ariaLabel:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2236
ariaLevel
ariaLevel:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2238
ariaLive
ariaLive:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2240
ariaModal
ariaModal:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2242
ariaMultiLine
ariaMultiLine:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2244
ariaMultiSelectable
ariaMultiSelectable:
null|string
Inherited from
BlockElement.ariaMultiSelectable
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2246
ariaOrientation
ariaOrientation:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2248
ariaPlaceholder
ariaPlaceholder:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2250
ariaPosInSet
ariaPosInSet:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2252
ariaPressed
ariaPressed:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2254
ariaReadOnly
ariaReadOnly:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2256
ariaRequired
ariaRequired:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2258
ariaRoleDescription
ariaRoleDescription:
null|string
Inherited from
BlockElement.ariaRoleDescription
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2260
ariaRowCount
ariaRowCount:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2262
ariaRowIndex
ariaRowIndex:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2264
ariaRowSpan
ariaRowSpan:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2266
ariaSelected
ariaSelected:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2268
ariaSetSize
ariaSetSize:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2270
ariaSort
ariaSort:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2272
ariaValueMax
ariaValueMax:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2274
ariaValueMin
ariaValueMin:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2276
ariaValueNow
ariaValueNow:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2278
ariaValueText
ariaValueText:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2280
assignedSlot
readonlyassignedSlot:null|HTMLSlotElement
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:21437
attributeStyleMap
readonlyattributeStyleMap:StylePropertyMap
Inherited from
BlockElement.attributeStyleMap
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7900
attributes
readonlyattributes:NamedNodeMap
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7644
attributesSchema
readonlyattributesSchema:ZodObject<Object,"strip",ZodTypeAny,Object,Object>
Type declaration
Source
packages/blocks/src/code-block/code-block.ts:162
autocapitalize
autocapitalize:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10105
autofocus
autofocus:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12118
baseURI
readonlybaseURI:string
Returns node's node document's document base URL.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16184
childElementCount
readonlychildElementCount:number
Inherited from
BlockElement.childElementCount
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16877
childNodes
readonlychildNodes:NodeListOf<ChildNode>
Returns the children.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16190
children
readonlychildren:HTMLCollection
Returns the child elements.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16883
classList
readonlyclassList:DOMTokenList
Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7650
className
className:
string
Returns the value of element's class content attribute. Can be set to change it.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7656
clientHeight
readonlyclientHeight:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7658
clientLeft
readonlyclientLeft:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7660
clientTop
readonlyclientTop:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7662
clientWidth
readonlyclientWidth:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7664
clipboardController
clipboardController:
CodeClipboardController
Source
packages/blocks/src/code-block/code-block.ts:142
content
content:
null|TemplateResult
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:15
contentEditable
contentEditable:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7907
dataset
readonlydataset:DOMStringMap
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12120
dir
dir:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10107
dirty
dirty:
boolean
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:18
disposables
readonlydisposables:DisposableGroup
Inherited from
Source
packages/framework/lit/dist/with-disposable.d.ts:4
doc
doc:
Doc
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:17
draggable
draggable:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10109
enterKeyHint
enterKeyHint:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7909
firstChild
readonlyfirstChild:null|ChildNode
Returns the first child.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16196
firstElementChild
readonlyfirstElementChild:null|Element
Returns the first child that is an element, and null otherwise.
Inherited from
BlockElement.firstElementChild
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16889
handleEvent
handleEvent: (
name,handler,options?) =>void
Parameters
• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"
• handler: UIEventHandler
• options?
• options.flavour?: boolean
• options.global?: boolean
Returns
void
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:32
hidden
hidden:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10111
highlightOptionsGetter
highlightOptionsGetter:
null|HighlightOptionsGetter=null
Source
packages/blocks/src/code-block/code-block.ts:160
host
host:
EditorHost
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:13
id
id:
string
Returns the value of element's id content attribute. Can be set to change it.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7670
inert
inert:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10113
innerHTML
innerHTML:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:14381
innerText
innerText:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10115
inputMode
inputMode:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7911
isConnected
readonlyisConnected:boolean
Returns true if node is connected and false otherwise.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16202
isContentEditable
readonlyisContentEditable:boolean
Inherited from
BlockElement.isContentEditable
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7913
lang
lang:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10117
lastChild
readonlylastChild:null|ChildNode
Returns the last child.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16208
lastElementChild
readonlylastElementChild:null|Element
Returns the last child that is an element, and null otherwise.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16895
localName
readonlylocalName:string
Returns the local name.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7676
model
model:
CodeBlockModel
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:14
namespaceURI
readonlynamespaceURI:null|string
Returns the namespace.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7682
nextElementSibling
readonlynextElementSibling:null|Element
Returns the first following sibling that is an element, and null otherwise.
Inherited from
BlockElement.nextElementSibling
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16464
nextSibling
readonlynextSibling:null|ChildNode
Returns the next sibling.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16214
nodeName
readonlynodeName:string
Returns a string appropriate for the type of node.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16220
nodeType
readonlynodeType:number
Returns the type of node.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16226
nodeValue
nodeValue:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16228
nonce?
optionalnonce:string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12122
offsetHeight
readonlyoffsetHeight:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10119
offsetLeft
readonlyoffsetLeft:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10121
offsetParent
readonlyoffsetParent:null|Element
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10123
offsetTop
readonlyoffsetTop:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10125
offsetWidth
readonlyoffsetWidth:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10127
onabort
onabort:
null| (this,ev) =>any
Fires when the user aborts the download.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:8994
onanimationcancel
onanimationcancel:
null| (this,ev) =>any
Inherited from
BlockElement.onanimationcancel
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:8996
onanimationend
onanimationend:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:8998
onanimationiteration
onanimationiteration:
null| (this,ev) =>any
Inherited from
BlockElement.onanimationiteration
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9000
onanimationstart
onanimationstart:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9002
onauxclick
onauxclick:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9004
onbeforeinput
onbeforeinput:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9006
onbeforetoggle
onbeforetoggle:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9008
onblur
onblur:
null| (this,ev) =>any
Fires when the object loses the input focus.
Param
The focus event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9015
oncancel
oncancel:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9017
oncanplay
oncanplay:
null| (this,ev) =>any
Occurs when playback is possible, but would require further buffering.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9024
oncanplaythrough
oncanplaythrough:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9026
onchange
onchange:
null| (this,ev) =>any
Fires when the contents of the object or selection have changed.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9033
onclick
onclick:
null| (this,ev) =>any
Fires when the user clicks the left mouse button on the object
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9040
onclose
onclose:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9042
oncontextmenu
oncontextmenu:
null| (this,ev) =>any
Fires when the user clicks the right mouse button in the client area, opening the context menu.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9049
oncopy
oncopy:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9051
oncuechange
oncuechange:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9053
oncut
oncut:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9055
ondblclick
ondblclick:
null| (this,ev) =>any
Fires when the user double-clicks the object.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9062
ondrag
ondrag:
null| (this,ev) =>any
Fires on the source object continuously during a drag operation.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9069
ondragend
ondragend:
null| (this,ev) =>any
Fires on the source object when the user releases the mouse at the close of a drag operation.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9076
ondragenter
ondragenter:
null| (this,ev) =>any
Fires on the target element when the user drags the object to a valid drop target.
Param
The drag event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9083
ondragleave
ondragleave:
null| (this,ev) =>any
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
Param
The drag event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9090
ondragover
ondragover:
null| (this,ev) =>any
Fires on the target element continuously while the user drags the object over a valid drop target.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9097
ondragstart
ondragstart:
null| (this,ev) =>any
Fires on the source object when the user starts to drag a text selection or selected object.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9104
ondrop
ondrop:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9106
ondurationchange
ondurationchange:
null| (this,ev) =>any
Occurs when the duration attribute is updated.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9113
onemptied
onemptied:
null| (this,ev) =>any
Occurs when the media element is reset to its initial state.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9120
onended
onended:
null| (this,ev) =>any
Occurs when the end of playback is reached.
Param
The event
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9127
onerror
onerror:
OnErrorEventHandler
Fires when an error occurs during object loading.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9134
onfocus
onfocus:
null| (this,ev) =>any
Fires when the object receives focus.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9141
onformdata
onformdata:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9143
onfullscreenchange
onfullscreenchange:
null| (this,ev) =>any
Inherited from
BlockElement.onfullscreenchange
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7684
onfullscreenerror
onfullscreenerror:
null| (this,ev) =>any
Inherited from
BlockElement.onfullscreenerror
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7686
ongotpointercapture
ongotpointercapture:
null| (this,ev) =>any
Inherited from
BlockElement.ongotpointercapture
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9145
oninput
oninput:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9147
oninvalid
oninvalid:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9149
onkeydown
onkeydown:
null| (this,ev) =>any
Fires when the user presses a key.
Param
The keyboard event
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9156
onkeypress
onkeypress:
null| (this,ev) =>any
Fires when the user presses an alphanumeric key.
Param
The event.
Deprecated
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9164
onkeyup
onkeyup:
null| (this,ev) =>any
Fires when the user releases a key.
Param
The keyboard event
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9171
onload
onload:
null| (this,ev) =>any
Fires immediately after the browser loads the object.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9178
onloadeddata
onloadeddata:
null| (this,ev) =>any
Occurs when media data is loaded at the current playback position.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9185
onloadedmetadata
onloadedmetadata:
null| (this,ev) =>any
Occurs when the duration and dimensions of the media have been determined.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9192
onloadstart
onloadstart:
null| (this,ev) =>any
Occurs when Internet Explorer begins looking for media data.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9199
onlostpointercapture
onlostpointercapture:
null| (this,ev) =>any
Inherited from
BlockElement.onlostpointercapture
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9201
onmousedown
onmousedown:
null| (this,ev) =>any
Fires when the user clicks the object with either mouse button.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9208
onmouseenter
onmouseenter:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9210
onmouseleave
onmouseleave:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9212
onmousemove
onmousemove:
null| (this,ev) =>any
Fires when the user moves the mouse over the object.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9219
onmouseout
onmouseout:
null| (this,ev) =>any
Fires when the user moves the mouse pointer outside the boundaries of the object.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9226
onmouseover
onmouseover:
null| (this,ev) =>any
Fires when the user moves the mouse pointer into the object.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9233
onmouseup
onmouseup:
null| (this,ev) =>any
Fires when the user releases a mouse button while the mouse is over the object.
Param
The mouse event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9240
onpaste
onpaste:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9242
onpause
onpause:
null| (this,ev) =>any
Occurs when playback is paused.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9249
onplay
onplay:
null| (this,ev) =>any
Occurs when the play method is requested.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9256
onplaying
onplaying:
null| (this,ev) =>any
Occurs when the audio or video has started playing.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9263
onpointercancel
onpointercancel:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9265
onpointerdown
onpointerdown:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9267
onpointerenter
onpointerenter:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9269
onpointerleave
onpointerleave:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9271
onpointermove
onpointermove:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9273
onpointerout
onpointerout:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9275
onpointerover
onpointerover:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9277
onpointerup
onpointerup:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9279
onprogress
onprogress:
null| (this,ev) =>any
Occurs to indicate progress while downloading media data.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9286
onratechange
onratechange:
null| (this,ev) =>any
Occurs when the playback rate is increased or decreased.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9293
onreset
onreset:
null| (this,ev) =>any
Fires when the user resets a form.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9300
onresize
onresize:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9302
onscroll
onscroll:
null| (this,ev) =>any
Fires when the user repositions the scroll box in the scroll bar on the object.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9309
onscrollend
onscrollend:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9311
onsecuritypolicyviolation
onsecuritypolicyviolation:
null| (this,ev) =>any
Inherited from
BlockElement.onsecuritypolicyviolation
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9313
onseeked
onseeked:
null| (this,ev) =>any
Occurs when the seek operation ends.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9320
onseeking
onseeking:
null| (this,ev) =>any
Occurs when the current playback position is moved.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9327
onselect
onselect:
null| (this,ev) =>any
Fires when the current selection changes.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9334
onselectionchange
onselectionchange:
null| (this,ev) =>any
Inherited from
BlockElement.onselectionchange
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9336
onselectstart
onselectstart:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9338
onslotchange
onslotchange:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9340
onstalled
onstalled:
null| (this,ev) =>any
Occurs when the download has stopped.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9347
onsubmit
onsubmit:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9349
onsuspend
onsuspend:
null| (this,ev) =>any
Occurs if the load operation has been intentionally halted.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9356
ontimeupdate
ontimeupdate:
null| (this,ev) =>any
Occurs to indicate the current playback position.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9363
ontoggle
ontoggle:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9365
ontouchcancel?
optionalontouchcancel:null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9367
ontouchend?
optionalontouchend:null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9369
ontouchmove?
optionalontouchmove:null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9371
ontouchstart?
optionalontouchstart:null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9373
ontransitioncancel
ontransitioncancel:
null| (this,ev) =>any
Inherited from
BlockElement.ontransitioncancel
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9375
ontransitionend
ontransitionend:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9377
ontransitionrun
ontransitionrun:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9379
ontransitionstart
ontransitionstart:
null| (this,ev) =>any
Inherited from
BlockElement.ontransitionstart
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9381
onvolumechange
onvolumechange:
null| (this,ev) =>any
Occurs when the volume is changed, or playback is muted or unmuted.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9388
onwaiting
onwaiting:
null| (this,ev) =>any
Occurs when playback stops because the next frame of a video resource is not available.
Param
The event.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9395
onwebkitanimationend
onwebkitanimationend:
null| (this,ev) =>any
Deprecated
This is a legacy alias of onanimationend.
Inherited from
BlockElement.onwebkitanimationend
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9401
onwebkitanimationiteration
onwebkitanimationiteration:
null| (this,ev) =>any
Deprecated
This is a legacy alias of onanimationiteration.
Inherited from
BlockElement.onwebkitanimationiteration
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9407
onwebkitanimationstart
onwebkitanimationstart:
null| (this,ev) =>any
Deprecated
This is a legacy alias of onanimationstart.
Inherited from
BlockElement.onwebkitanimationstart
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9413
onwebkittransitionend
onwebkittransitionend:
null| (this,ev) =>any
Deprecated
This is a legacy alias of ontransitionend.
Inherited from
BlockElement.onwebkittransitionend
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9419
onwheel
onwheel:
null| (this,ev) =>any
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:9421
outerHTML
outerHTML:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7688
outerText
outerText:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10129
ownerDocument
readonlyownerDocument:Document
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7689
parentElement
readonlyparentElement:null|HTMLElement
Returns the parent element.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16240
parentNode
readonlyparentNode:null|ParentNode
Returns the parent.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16246
part
readonlypart:DOMTokenList
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7691
path
path:
string[]
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:21
popover
popover:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10131
prefix
readonlyprefix:null|string
Returns the namespace prefix.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7697
previousElementSibling
readonlypreviousElementSibling:null|Element
Returns the first preceding sibling that is an element, and null otherwise.
Inherited from
BlockElement.previousElementSibling
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16470
previousSibling
readonlypreviousSibling:null|ChildNode
Returns the previous sibling.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16252
renderChildren
renderChildren: (
model) =>TemplateResult
Parameters
• model: BlockModel<object>
Returns
TemplateResult
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:40
role
role:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2281
scrollHeight
readonlyscrollHeight:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7699
scrollLeft
scrollLeft:
number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7701
scrollTop
scrollTop:
number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7703
scrollWidth
readonlyscrollWidth:number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7705
selected
selected:
null|BaseSelection
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:19
service
service:
BlockService<BlockModel<object>>
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:20
shadowRoot
readonlyshadowRoot:null|ShadowRoot
Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7711
slot
slot:
string
Returns the value of element's slot content attribute. Can be set to change it.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7717
spellcheck
spellcheck:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10133
style
readonlystyle:CSSStyleDeclaration
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7902
tabIndex
tabIndex:
number
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12124
tagName
readonlytagName:string
Returns the HTML-uppercased qualified name.
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7723
textContent
textContent:
null|string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16254
title
title:
string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10135
translate
translate:
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10137
widgets
widgets:
Record<string,TemplateResult>
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:16
[metadata]
static[metadata]:object&Record<PropertyKey,unknown>
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:417
_$litElement$
static_$litElement$:boolean
Inherited from
Source
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:84
_initializers?
staticoptional_initializers:Initializer[]
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:258
disableShadowRoot
staticdisableShadowRoot:boolean
Inherited from
BlockElement.disableShadowRoot
Source
packages/framework/lit/dist/element/shadowless-element.d.ts:4
finalized
protectedstaticfinalized:undefined|true
Marks class as having been finalized, which includes creating properties from static properties, but does not include all properties created from decorators.
Nocollapse
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:272
styles
staticstyles:CSSResult
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
Overrides
Source
packages/blocks/src/code-block/code-block.ts:47
_showLangList
getprivate_showLangList():boolean
Returns
boolean
Source
packages/blocks/src/code-block/code-block.ts:144
childBlockElements
getchildBlockElements():BlockElement<BlockModel<object>,BlockService<BlockModel<object>>,string>[]
Returns
BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]
Source
packages/framework/lit/dist/element/block-element.d.ts:24
flavour
getflavour():string
Returns
string
Source
packages/framework/lit/dist/element/block-element.d.ts:27
inlineEditor
getinlineEditor():InlineEditor<Object>
Returns
InlineEditor<Object>
bold?
optionalbold:null|truecode?
optionalcode:null|trueitalic?
optionalitalic:null|truelink?
optionallink:null|stringstrike?
optionalstrike:null|trueunderline?
optionalunderline:null|true
Source
packages/blocks/src/code-block/code-block.ts:224
isVersionMismatch
getisVersionMismatch():boolean
Returns
boolean
Source
packages/framework/lit/dist/element/block-element.d.ts:31
parentBlockElement
getparentBlockElement():BlockElement<BlockModel<object>,BlockService<BlockModel<object>>,string>
Returns
BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>
Source
packages/framework/lit/dist/element/block-element.d.ts:23
parentPath
getparentPath():string[]
Returns
string[]
Source
packages/framework/lit/dist/element/block-element.d.ts:22
readonly
getreadonly():boolean
Returns
boolean
Source
packages/blocks/src/code-block/code-block.ts:148
rootElement
getrootElement():BlockElement<BlockModel<object>,BlockService<BlockModel<object>>,string>
Returns
BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>
Source
packages/framework/lit/dist/element/block-element.d.ts:25
selection
getselection():SelectionManager
Returns
Source
packages/framework/lit/dist/element/block-element.d.ts:29
std
getstd():BlockStdScope
Returns
Source
packages/framework/lit/dist/element/block-element.d.ts:30
topContenteditableElement
gettopContenteditableElement():null|BlockElement<BlockModel<object>,BlockService<BlockModel<object>>,string>
Returns
null | BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>
Source
packages/blocks/src/code-block/code-block.ts:152
widgetElements
getwidgetElements():Partial<Record<WidgetName,WidgetElement<BlockElement<BlockModel<object>,BlockService<BlockModel<object>>,string>>>>
Returns
Partial<Record<WidgetName, WidgetElement<BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>>>>
Source
packages/framework/lit/dist/element/block-element.d.ts:28
_curLanguageButtonTemplate()
private_curLanguageButtonTemplate():TemplateResult<1>
Returns
TemplateResult<1>
Source
packages/blocks/src/code-block/code-block.ts:531
_onClickLangBtn()
private_onClickLangBtn():void
Returns
void
Source
packages/blocks/src/code-block/code-block.ts:511
_startHighlight()
private_startHighlight(lang):Promise<void>
Parameters
• lang: StrictLanguageInfo
Returns
Promise<void>
Source
packages/blocks/src/code-block/code-block.ts:189
_updateLineNumbers()
private_updateLineNumbers():void
Returns
void
Source
packages/blocks/src/code-block/code-block.ts:554
addEventListener()
addEventListener(type, listener, options)
addEventListener<
K>(type,listener,options?):void
Type parameters
• K extends keyof HTMLElementEventMap
Parameters
• type: K
• listener
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10148
addEventListener(type, listener, options)
addEventListener(
type,listener,options?):void
Parameters
• type: string
• listener: EventListenerOrEventListenerObject
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10149
after()
after(...
nodes):void
Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:5641
animate()
animate(
keyframes,options?):Animation
Parameters
• keyframes: null | Keyframe[] | PropertyIndexedKeyframes
• options?: number | KeyframeAnimationOptions
Returns
Animation
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2431
append()
append(...
nodes):void
Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16903
appendChild()
appendChild<
T>(node):T
Type parameters
• T extends Node
Parameters
• node: T
Returns
T
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16256
attachInternals()
attachInternals():
ElementInternals
Returns
ElementInternals
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10139
attachShadow()
attachShadow(
init):ShadowRoot
Creates a shadow root for element and returns it.
Parameters
• init: ShadowRootInit
Returns
ShadowRoot
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7729
before()
before(...
nodes):void
Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:5649
bindHotKey()
bindHotKey(
keymap,options?):void
Parameters
• keymap: Record<string, UIEventHandler>
• options?
• options.flavour?: boolean
• options.global?: boolean
Returns
void
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:36
blur()
blur():
void
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12126
checkVisibility()
checkVisibility(
options?):boolean
Parameters
• options?: CheckVisibilityOptions
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7731
click()
click():
void
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10141
cloneNode()
cloneNode(
deep?):Node
Returns a copy of node. If deep is true, the copy also includes the node's descendants.
Parameters
• deep?: boolean
Returns
Node
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16262
closest()
closest(selector)
closest<
K>(selector):null|HTMLElementTagNameMap[K]
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Type parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selector: K
Returns
null | HTMLElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7737
closest(selector)
closest<
K>(selector):null|SVGElementTagNameMap[K]
Type parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selector: K
Returns
null | SVGElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7738
closest(selector)
closest<
K>(selector):null|MathMLElementTagNameMap[K]
Type parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selector: K
Returns
null | MathMLElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7739
closest(selectors)
closest<
E>(selectors):null|E
Type parameters
• E extends Element = Element
Parameters
• selectors: string
Returns
null | E
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7740
compareDocumentPosition()
compareDocumentPosition(
other):number
Returns a bitmask indicating the position of other relative to node.
Parameters
• other: Node
Returns
number
Inherited from
BlockElement.compareDocumentPosition
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16268
computedStyleMap()
computedStyleMap():
StylePropertyMapReadOnly
Returns
StylePropertyMapReadOnly
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7742
connectedCallback()
connectedCallback():
void
Returns
void
Overrides
BlockElement.connectedCallback
Source
packages/blocks/src/code-block/code-block.ts:296
contains()
contains(
other):boolean
Returns true if other is an inclusive descendant of node, and false otherwise.
Parameters
• other: null | Node
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16274
createRenderRoot()
createRenderRoot():
HTMLElement|DocumentFragment
Returns
HTMLElement | DocumentFragment
Inherited from
Source
packages/framework/lit/dist/element/shadowless-element.d.ts:6
disconnectedCallback()
disconnectedCallback():
void
Returns
void
Overrides
BlockElement.disconnectedCallback
Source
packages/blocks/src/code-block/code-block.ts:471
dispatchEvent()
dispatchEvent(
event):boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
• event: Event
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:8262
focus()
focus(
options?):void
Parameters
• options?: FocusOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:12128
getAnimations()
getAnimations(
options?):Animation[]
Parameters
• options?: GetAnimationsOptions
Returns
Animation[]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:2433
getAttribute()
getAttribute(
qualifiedName):null|string
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
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7748
getAttributeNS()
getAttributeNS(
namespace,localName):null|string
Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.
Parameters
• namespace: null | string
• localName: string
Returns
null | string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7754
getAttributeNames()
getAttributeNames():
string[]
Returns the qualified names of all element's attributes. Can contain duplicates.
Returns
string[]
Inherited from
BlockElement.getAttributeNames
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7760
getAttributeNode()
getAttributeNode(
qualifiedName):null|Attr
Parameters
• qualifiedName: string
Returns
null | Attr
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7762
getAttributeNodeNS()
getAttributeNodeNS(
namespace,localName):null|Attr
Parameters
• namespace: null | string
• localName: string
Returns
null | Attr
Inherited from
BlockElement.getAttributeNodeNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7764
getAttributeRenderer()
readonlygetAttributeRenderer():AttributeRenderer
Returns
Source
packages/blocks/src/code-block/code-block.ts:163
getBoundingClientRect()
getBoundingClientRect():
DOMRect
Returns
DOMRect
Inherited from
BlockElement.getBoundingClientRect
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7766
getClientRects()
getClientRects():
DOMRectList
Returns
DOMRectList
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7768
getElementsByClassName()
getElementsByClassName(
classNames):HTMLCollectionOf<Element>
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Parameters
• classNames: string
Returns
HTMLCollectionOf<Element>
Inherited from
BlockElement.getElementsByClassName
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7774
getElementsByTagName()
getElementsByTagName(qualifiedName)
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<HTMLElementTagNameMap[K]>
Type parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf<HTMLElementTagNameMap[K]>
Inherited from
BlockElement.getElementsByTagName
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7776
getElementsByTagName(qualifiedName)
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<SVGElementTagNameMap[K]>
Type parameters
• K extends keyof SVGElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf<SVGElementTagNameMap[K]>
Inherited from
BlockElement.getElementsByTagName
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7777
getElementsByTagName(qualifiedName)
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<MathMLElementTagNameMap[K]>
Type parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf<MathMLElementTagNameMap[K]>
Inherited from
BlockElement.getElementsByTagName
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7778
getElementsByTagName(qualifiedName)
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Type parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• qualifiedName: K
Returns
HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Inherited from
BlockElement.getElementsByTagName
Deprecated
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7780
getElementsByTagName(qualifiedName)
getElementsByTagName(
qualifiedName):HTMLCollectionOf<Element>
Parameters
• qualifiedName: string
Returns
HTMLCollectionOf<Element>
Inherited from
BlockElement.getElementsByTagName
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7781
getElementsByTagNameNS()
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<HTMLElement>
Parameters
• namespaceURI: "http://www.w3.org/1999/xhtml"
• localName: string
Returns
HTMLCollectionOf<HTMLElement>
Inherited from
BlockElement.getElementsByTagNameNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7783
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<SVGElement>
Parameters
• namespaceURI: "http://www.w3.org/2000/svg"
• localName: string
Returns
HTMLCollectionOf<SVGElement>
Inherited from
BlockElement.getElementsByTagNameNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7784
getElementsByTagNameNS(namespaceURI, localName)
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<MathMLElement>
Parameters
• namespaceURI: "http://www.w3.org/1998/Math/MathML"
• localName: string
Returns
HTMLCollectionOf<MathMLElement>
Inherited from
BlockElement.getElementsByTagNameNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7785
getElementsByTagNameNS(namespace, localName)
getElementsByTagNameNS(
namespace,localName):HTMLCollectionOf<Element>
Parameters
• namespace: null | string
• localName: string
Returns
HTMLCollectionOf<Element>
Inherited from
BlockElement.getElementsByTagNameNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7786
getRootNode()
getRootNode(
options?):Node
Returns node's root.
Parameters
• options?: GetRootNodeOptions
Returns
Node
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16280
getUpdateComplete()
getUpdateComplete():
Promise<boolean>
Returns
Promise<boolean>
Overrides
BlockElement.getUpdateComplete
Source
packages/blocks/src/code-block/code-block.ts:290
hasAttribute()
hasAttribute(
qualifiedName):boolean
Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.
Parameters
• qualifiedName: string
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7792
hasAttributeNS()
hasAttributeNS(
namespace,localName):boolean
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
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7798
hasAttributes()
hasAttributes():
boolean
Returns true if element has attributes, and false otherwise.
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7804
hasChildNodes()
hasChildNodes():
boolean
Returns whether node has children.
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16286
hasPointerCapture()
hasPointerCapture(
pointerId):boolean
Parameters
• pointerId: number
Returns
boolean
Inherited from
BlockElement.hasPointerCapture
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7806
hidePopover()
hidePopover():
void
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10143
insertAdjacentElement()
insertAdjacentElement(
where,element):null|Element
Parameters
• where: InsertPosition
• element: Element
Returns
null | Element
Inherited from
BlockElement.insertAdjacentElement
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7808
insertAdjacentHTML()
insertAdjacentHTML(
position,text):void
Parameters
• position: InsertPosition
• text: string
Returns
void
Inherited from
BlockElement.insertAdjacentHTML
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7810
insertAdjacentText()
insertAdjacentText(
where,data):void
Parameters
• where: InsertPosition
• data: string
Returns
void
Inherited from
BlockElement.insertAdjacentText
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7812
insertBefore()
insertBefore<
T>(node,child):T
Type parameters
• T extends Node
Parameters
• node: T
• child: null | Node
Returns
T
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16288
isDefaultNamespace()
isDefaultNamespace(
namespace):boolean
Parameters
• namespace: null | string
Returns
boolean
Inherited from
BlockElement.isDefaultNamespace
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16290
isEqualNode()
isEqualNode(
otherNode):boolean
Returns whether node and otherNode have the same properties.
Parameters
• otherNode: null | Node
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16296
isSameNode()
isSameNode(
otherNode):boolean
Parameters
• otherNode: null | Node
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16298
lookupNamespaceURI()
lookupNamespaceURI(
prefix):null|string
Parameters
• prefix: null | string
Returns
null | string
Inherited from
BlockElement.lookupNamespaceURI
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16300
lookupPrefix()
lookupPrefix(
namespace):null|string
Parameters
• namespace: null | string
Returns
null | string
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16302
matches()
matches(
selectors):boolean
Returns true if matching selectors against element's root yields element, and false otherwise.
Parameters
• selectors: string
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7818
normalize()
normalize():
void
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
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16308
prepend()
prepend(...
nodes):void
Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16911
querySelector()
querySelector(selectors)
querySelector<
K>(selectors):null|HTMLElementTagNameMap[K]
Returns the first element that is a descendant of node that matches selectors.
Type parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selectors: K
Returns
null | HTMLElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16917
querySelector(selectors)
querySelector<
K>(selectors):null|SVGElementTagNameMap[K]
Type parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selectors: K
Returns
null | SVGElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16918
querySelector(selectors)
querySelector<
K>(selectors):null|MathMLElementTagNameMap[K]
Type parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selectors: K
Returns
null | MathMLElementTagNameMap[K]
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16919
querySelector(selectors)
querySelector<
K>(selectors):null|HTMLElementDeprecatedTagNameMap[K]
Type parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• selectors: K
Returns
null | HTMLElementDeprecatedTagNameMap[K]
Inherited from
Deprecated
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16921
querySelector(selectors)
querySelector<
E>(selectors):null|E
Type parameters
• E extends Element = Element
Parameters
• selectors: string
Returns
null | E
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16922
querySelectorAll()
querySelectorAll(selectors)
querySelectorAll<
K>(selectors):NodeListOf<HTMLElementTagNameMap[K]>
Returns all element descendants of node that match selectors.
Type parameters
• K extends keyof HTMLElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf<HTMLElementTagNameMap[K]>
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16928
querySelectorAll(selectors)
querySelectorAll<
K>(selectors):NodeListOf<SVGElementTagNameMap[K]>
Type parameters
• K extends keyof SVGElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf<SVGElementTagNameMap[K]>
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16929
querySelectorAll(selectors)
querySelectorAll<
K>(selectors):NodeListOf<MathMLElementTagNameMap[K]>
Type parameters
• K extends keyof MathMLElementTagNameMap
Parameters
• selectors: K
Returns
NodeListOf<MathMLElementTagNameMap[K]>
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16930
querySelectorAll(selectors)
querySelectorAll<
K>(selectors):NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Type parameters
• K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
• selectors: K
Returns
NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Inherited from
Deprecated
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16932
querySelectorAll(selectors)
querySelectorAll<
E>(selectors):NodeListOf<E>
Type parameters
• E extends Element = Element
Parameters
• selectors: string
Returns
NodeListOf<E>
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16933
releasePointerCapture()
releasePointerCapture(
pointerId):void
Parameters
• pointerId: number
Returns
void
Inherited from
BlockElement.releasePointerCapture
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7820
remove()
remove():
void
Removes node.
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:5655
removeAttribute()
removeAttribute(
qualifiedName):void
Removes element's first attribute whose qualified name is qualifiedName.
Parameters
• qualifiedName: string
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7826
removeAttributeNS()
removeAttributeNS(
namespace,localName):void
Removes element's attribute whose namespace is namespace and local name is localName.
Parameters
• namespace: null | string
• localName: string
Returns
void
Inherited from
BlockElement.removeAttributeNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7832
removeAttributeNode()
removeAttributeNode(
attr):Attr
Parameters
• attr: Attr
Returns
Attr
Inherited from
BlockElement.removeAttributeNode
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7834
removeChild()
removeChild<
T>(child):T
Type parameters
• T extends Node
Parameters
• child: T
Returns
T
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16310
removeEventListener()
removeEventListener(type, listener, options)
removeEventListener<
K>(type,listener,options?):void
Type parameters
• K extends keyof HTMLElementEventMap
Parameters
• type: K
• listener
• options?: boolean | EventListenerOptions
Returns
void
Inherited from
BlockElement.removeEventListener
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10150
removeEventListener(type, listener, options)
removeEventListener(
type,listener,options?):void
Parameters
• type: string
• listener: EventListenerOrEventListenerObject
• options?: boolean | EventListenerOptions
Returns
void
Inherited from
BlockElement.removeEventListener
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10151
render()
render():
unknown
Returns
unknown
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:47
renderBlock()
renderBlock():
TemplateResult<1>
Returns
TemplateResult<1>
Overrides
Source
packages/blocks/src/code-block/code-block.ts:567
renderVersionMismatch()
renderVersionMismatch(
expectedVersion,actualVersion):TemplateResult
Parameters
• expectedVersion: number
• actualVersion: number
Returns
TemplateResult
Inherited from
BlockElement.renderVersionMismatch
Source
packages/framework/lit/dist/element/block-element.d.ts:46
replaceChild()
replaceChild<
T>(node,child):T
Type parameters
• T extends Node
Parameters
• node: Node
• child: T
Returns
T
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16312
replaceChildren()
replaceChildren(...
nodes):void
Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:16941
replaceWith()
replaceWith(...
nodes):void
Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.
Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
Parameters
• ...nodes: (string | Node)[]
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:5663
requestFullscreen()
requestFullscreen(
options?):Promise<void>
Displays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
Parameters
• options?: FullscreenOptions
Returns
Promise<void>
Inherited from
BlockElement.requestFullscreen
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7842
requestPointerLock()
requestPointerLock():
void
Returns
void
Inherited from
BlockElement.requestPointerLock
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7844
scroll()
scroll(options)
scroll(
options?):void
Parameters
• options?: ScrollToOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7846
scroll(x, y)
scroll(
x,y):void
Parameters
• x: number
• y: number
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7847
scrollBy()
scrollBy(options)
scrollBy(
options?):void
Parameters
• options?: ScrollToOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7849
scrollBy(x, y)
scrollBy(
x,y):void
Parameters
• x: number
• y: number
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7850
scrollIntoView()
scrollIntoView(
arg?):void
Parameters
• arg?: boolean | ScrollIntoViewOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7852
scrollTo()
scrollTo(options)
scrollTo(
options?):void
Parameters
• options?: ScrollToOptions
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7854
scrollTo(x, y)
scrollTo(
x,y):void
Parameters
• x: number
• y: number
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7855
setAttribute()
setAttribute(
qualifiedName,value):void
Sets the value of element's first attribute whose qualified name is qualifiedName to value.
Parameters
• qualifiedName: string
• value: string
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7861
setAttributeNS()
setAttributeNS(
namespace,qualifiedName,value):void
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
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7867
setAttributeNode()
setAttributeNode(
attr):null|Attr
Parameters
• attr: Attr
Returns
null | Attr
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7869
setAttributeNodeNS()
setAttributeNodeNS(
attr):null|Attr
Parameters
• attr: Attr
Returns
null | Attr
Inherited from
BlockElement.setAttributeNodeNS
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7871
setHighlightOptionsGetter()
setHighlightOptionsGetter(
fn):void
Parameters
• fn: HighlightOptionsGetter
Returns
void
Source
packages/blocks/src/code-block/code-block.ts:499
setLang()
setLang(
lang):void
Parameters
• lang: null | string
Returns
void
Source
packages/blocks/src/code-block/code-block.ts:503
setPointerCapture()
setPointerCapture(
pointerId):void
Parameters
• pointerId: number
Returns
void
Inherited from
BlockElement.setPointerCapture
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7873
showPopover()
showPopover():
void
Returns
void
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10145
toggleAttribute()
toggleAttribute(
qualifiedName,force?):boolean
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Parameters
• qualifiedName: string
• force?: boolean
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7881
togglePopover()
togglePopover(
force?):boolean
Parameters
• force?: boolean
Returns
boolean
Inherited from
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:10147
update()
protectedupdate(changedProperties):void
Parameters
• changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
Source
packages/framework/lit/dist/element/block-element.d.ts:42
updated()
updated():
void
Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.
Setting properties inside this method will trigger the element to update again after this update cycle completes.
Returns
void
Overrides
Source
packages/blocks/src/code-block/code-block.ts:477
webkitMatchesSelector()
webkitMatchesSelector(
selectors):boolean
Parameters
• selectors: string
Returns
boolean
Inherited from
BlockElement.webkitMatchesSelector
Deprecated
This is a legacy alias of matches.
Source
node_modules/.pnpm/typescript@5.4.2/node_modules/typescript/lib/lib.dom.d.ts:7887
addInitializer()
staticaddInitializer(initializer):void
Adds an initializer function to the class that is called during instance construction.
This is useful for code that runs against a ReactiveElement subclass, such as a decorator, that needs to do work for each instance, such as setting up a ReactiveController.
const myDecorator = (target: typeof ReactiveElement, key: string) => {
target.addInitializer((instance: ReactiveElement) => {
// This is run during construction of the element
new MyController(instance);
});
}Decorating a field will then cause each instance to run an initializer that adds a controller:
class MyElement extends LitElement {
@myDecorator foo;
}Initializers are stored per-constructor. Adding an initializer to a subclass does not add it to a superclass. Since initializers are run in constructors, initializers will run in order of the class hierarchy, starting with superclasses and progressing to the instance's class.
Parameters
• initializer: Initializer
Returns
void
Inherited from
Nocollapse
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:257
finalize()
protectedstaticfinalize():void
Finishes setting up the class so that it's ready to be registered as a custom element and instantiated.
This method is called by the ReactiveElement.observedAttributes getter. If you override the observedAttributes getter, you must either call super.observedAttributes to trigger finalization, or call finalize() yourself.
Returns
void
Inherited from
Nocollapse
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:441
finalizeStyles()
protectedstaticfinalizeStyles(styles?):CSSResultOrNative[]
Parameters
• styles?: CSSResultGroup
Returns
CSSResultOrNative[]
Inherited from
Source
packages/framework/lit/dist/element/shadowless-element.d.ts:5
attributes
observedAttributes
getstaticobservedAttributes():string[]
Returns a list of attributes corresponding to the registered properties.
Nocollapse
Returns
string[]
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:346
attributeChangedCallback()
attributeChangedCallback(
name,_old,value):void
Synchronizes property values when attributes change.
Specifically, when an attribute is set, the corresponding property is set. You should rarely need to implement this callback. If this method is overridden, super.attributeChangedCallback(name, _old, value) must be called.
See using the lifecycle callbacks on MDN for more information about the attributeChangedCallback.
Parameters
• name: string
• _old: null | string
• value: null | string
Returns
void
Inherited from
BlockElement.attributeChangedCallback
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:580
controllers
addController()
addController(
controller):void
Registers a ReactiveController to participate in the element's reactive update cycle. The element automatically calls into any registered controllers during its lifecycle callbacks.
If the element is connected when addController() is called, the controller's hostConnected() callback will be immediately called.
Parameters
• controller: ReactiveController
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:519
removeController()
removeController(
controller):void
Removes a ReactiveController from the element.
Parameters
• controller: ReactiveController
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:524
dev-mode
disableWarning?
staticoptionaldisableWarning: (warningKind) =>void
Disable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
// Disable for all ReactiveElement subclasses
ReactiveElement.disableWarning?.('migration');
// Disable for only MyElement and subclasses
MyElement.disableWarning?.('migration');Nocollapse
Parameters
• warningKind: WarningKind
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:223
enableWarning?
staticoptionalenableWarning: (warningKind) =>void
Enable the given warning category for this class.
This method only exists in development builds, so it should be accessed with a guard like:
// Enable for all ReactiveElement subclasses
ReactiveElement.enableWarning?.('migration');
// Enable for only MyElement and subclasses
MyElement.enableWarning?.('migration');Nocollapse
Parameters
• warningKind: WarningKind
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:205
enabledWarnings?
staticoptionalenabledWarnings:WarningKind[]
Read or set all the enabled warning categories for this class.
This property is only used in development builds.
Nocollapse
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:187
properties
elementProperties
staticelementProperties:PropertyDeclarationMap
Memoized list of all element properties, including any superclass properties. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
BlockElement.elementProperties
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:280
properties
staticproperties:PropertyDeclarations
User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.
By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.
Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute
However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.
Nocollapse
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:306
createProperty()
staticcreateProperty(name,options?):void
Creates a property accessor on the element prototype if one does not exist and stores a PropertyDeclaration for the property with the given options. The property setter calls the property's hasChanged property option or uses a strict identity check to determine whether or not to request an update.
This method may be overridden to customize properties; however, when doing so, it's important to call super.createProperty to ensure the property is setup correctly. This method calls getPropertyDescriptor internally to get a descriptor to install. To customize what properties do when they are get or set, override getPropertyDescriptor. To customize the options for a property, implement createProperty like this:
static createProperty(name, options) {
options = Object.assign(options, {myOption: true});
super.createProperty(name, options);
}Parameters
• name: PropertyKey
• options?: PropertyDeclaration<unknown, unknown>
Returns
void
Inherited from
Nocollapse
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:373
getPropertyDescriptor()
protectedstaticgetPropertyDescriptor(name,key,options):undefined|PropertyDescriptor
Returns a property descriptor to be defined on the given named property. If no descriptor is returned, the property will not become an accessor. For example,
class MyElement extends LitElement {
static getPropertyDescriptor(name, key, options) {
const defaultDescriptor =
super.getPropertyDescriptor(name, key, options);
const setter = defaultDescriptor.set;
return {
get: defaultDescriptor.get,
set(value) {
setter.call(this, value);
// custom action.
},
configurable: true,
enumerable: true
}
}
}Parameters
• name: PropertyKey
• key: string | symbol
• options: PropertyDeclaration<unknown, unknown>
Returns
undefined | PropertyDescriptor
Inherited from
BlockElement.getPropertyDescriptor
Nocollapse
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:401
getPropertyOptions()
staticgetPropertyOptions(name):PropertyDeclaration<unknown,unknown>
Returns the property options associated with the given property. These options are defined with a PropertyDeclaration via the properties object or the @property decorator and are registered in createProperty(...).
Note, this method should be considered "final" and not overridden. To customize the options for a given property, override createProperty.
Parameters
• name: PropertyKey
Returns
PropertyDeclaration<unknown, unknown>
Inherited from
BlockElement.getPropertyOptions
Nocollapse
Final
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:416
rendering
renderOptions
readonlyrenderOptions:RenderOptions
Inherited from
Source
node_modules/.pnpm/lit-element@4.0.4/node_modules/lit-element/development/lit-element.d.ts:88
renderRoot
readonlyrenderRoot:HTMLElement|DocumentFragment
Node or ShadowRoot into which element DOM should be rendered. Defaults to an open shadowRoot.
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:473
shadowRootOptions
staticshadowRootOptions:ShadowRootInit
Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.
Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.
Nocollapse
Inherited from
BlockElement.shadowRootOptions
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:452
styles
elementStyles
staticelementStyles:CSSResultOrNative[]
Memoized list of all element styles. Created lazily on user subclasses when finalizing the class.
Nocollapse
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:313
updates
hasUpdated
hasUpdated:
boolean
Is set to true after the first update. The element code cannot assume that renderRoot exists before the element hasUpdated.
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:491
isUpdatePending
isUpdatePending:
boolean
True if there is a pending update as a result of calling requestUpdate(). Should only be read.
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:485
updateComplete
getupdateComplete():Promise<boolean>
Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.
To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.
Returns
Promise<boolean>
A promise of a boolean that resolves to true if the update completed without triggering another update.
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:669
enableUpdating()
protectedenableUpdating(_requestedUpdate):void
Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.
Parameters
• _requestedUpdate: boolean
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:560
firstUpdated()
protectedfirstUpdated(_changedProperties):void
Invoked when the element is first updated. Implement to perform one time work on the element after update.
firstUpdated() {
this.renderRoot.getElementById('my-text-area').focus();
}Setting properties inside this method will trigger the element to update again after this update cycle completes.
Parameters
• _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>
Map of changed properties with old values
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:740
performUpdate()
protectedperformUpdate():void
Performs an element update. Note, if an exception is thrown during the update, firstUpdated and updated will not be called.
Call performUpdate() to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:629
requestUpdate()
requestUpdate(
name?,oldValue?,options?):void
Requests an update which is processed asynchronously. This should be called when an element should update based on some state not triggered by setting a reactive property. In this case, pass no arguments. It should also be called when manually implementing a property setter. In this case, pass the property name and oldValue to ensure that any configured property options are honored.
Parameters
• 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
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:596
scheduleUpdate()
protectedscheduleUpdate():void|Promise<unknown>
Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.
For instance, to schedule updates to occur just before the next frame:
override protected async scheduleUpdate(): Promise<unknown> {
await new Promise((resolve) => requestAnimationFrame(() => resolve()));
super.scheduleUpdate();
}Returns
void | Promise<unknown>
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:618
shouldUpdate()
protectedshouldUpdate(_changedProperties):boolean
Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.
Parameters
• _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>
Map of changed properties with old values
Returns
boolean
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:702
willUpdate()
protectedwillUpdate(_changedProperties):void
Invoked before update() to compute values needed during the update.
Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.
willUpdate(changedProperties) {
// only need to check changed properties for an expensive computation.
if (changedProperties.has('firstName') || changedProperties.has('lastName')) {
this.sha = computeSHA(`${this.firstName} ${this.lastName}`);
}
}
render() {
return html`SHA: ${this.sha}`;
}Parameters
• _changedProperties: PropertyValueMap<any> | Map<PropertyKey, unknown>
Returns
void
Inherited from
Source
node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:651