Skip to content

BlockSuite API Documentation / @blocksuite/blocks / AffineDragHandleWidget

Class: AffineDragHandleWidget

Extends

Other

new AffineDragHandleWidget(undefined)

new AffineDragHandleWidget(): AffineDragHandleWidget

Returns

AffineDragHandleWidget

Inherited from

@blocksuite/lit.WidgetElement.constructor

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504


ATTRIBUTE_NODE

readonly ATTRIBUTE_NODE: 2

Inherited from

@blocksuite/lit.WidgetElement.ATTRIBUTE_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16205


CDATA_SECTION_NODE

readonly CDATA_SECTION_NODE: 4

node is a CDATASection node.

Inherited from

@blocksuite/lit.WidgetElement.CDATA_SECTION_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16209


COMMENT_NODE

readonly COMMENT_NODE: 8

node is a Comment node.

Inherited from

@blocksuite/lit.WidgetElement.COMMENT_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16215


DOCUMENT_FRAGMENT_NODE

readonly DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_FRAGMENT_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16221


DOCUMENT_NODE

readonly DOCUMENT_NODE: 9

node is a document.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16217


DOCUMENT_POSITION_CONTAINED_BY

readonly DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_CONTAINED_BY

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16232


DOCUMENT_POSITION_CONTAINS

readonly DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_CONTAINS

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16230


DOCUMENT_POSITION_DISCONNECTED

readonly DOCUMENT_POSITION_DISCONNECTED: 1

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

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_DISCONNECTED

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16224


DOCUMENT_POSITION_FOLLOWING

readonly DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_FOLLOWING

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16228


DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16233


DOCUMENT_POSITION_PRECEDING

readonly DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_POSITION_PRECEDING

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16226


DOCUMENT_TYPE_NODE

readonly DOCUMENT_TYPE_NODE: 10

node is a doctype.

Inherited from

@blocksuite/lit.WidgetElement.DOCUMENT_TYPE_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16219


ELEMENT_NODE

readonly ELEMENT_NODE: 1

node is an element.

Inherited from

@blocksuite/lit.WidgetElement.ELEMENT_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16204


ENTITY_NODE

readonly ENTITY_NODE: 6

Inherited from

@blocksuite/lit.WidgetElement.ENTITY_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16211


ENTITY_REFERENCE_NODE

readonly ENTITY_REFERENCE_NODE: 5

Inherited from

@blocksuite/lit.WidgetElement.ENTITY_REFERENCE_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16210


NOTATION_NODE

readonly NOTATION_NODE: 12

Inherited from

@blocksuite/lit.WidgetElement.NOTATION_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16222


PROCESSING_INSTRUCTION_NODE

readonly PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

Inherited from

@blocksuite/lit.WidgetElement.PROCESSING_INSTRUCTION_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16213


TEXT_NODE

readonly TEXT_NODE: 3

node is a Text node.

Inherited from

@blocksuite/lit.WidgetElement.TEXT_NODE

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16207


_anchorBlockId

private _anchorBlockId: string = ''

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:124


_anchorBlockPath

private _anchorBlockPath: null | string[] = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:125


_anchorModelDisposables

private _anchorModelDisposables: null | DisposableGroup = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:127


_clickHandler

private _clickHandler: UIEventHandler

When click on drag handle Should select the block and show slash menu if current block is not selected Should clear selection if current block is the first selected block

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:992


_disposables

protected _disposables: DisposableGroup

Inherited from

@blocksuite/lit.WidgetElement._disposables

Source

packages/framework/lit/dist/with-disposable.d.ts:5


_dragEndHandler

private _dragEndHandler: UIEventHandler

When drag end, should move blocks to drop position

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1319


_dragHandleContainer

private _dragHandleContainer: HTMLDivElement

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:91


_dragHandleGrabber

private _dragHandleGrabber: HTMLDivElement

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:94


_dragHoverRect

private _dragHoverRect: null | Object = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:110


_dragMoveHandler

private _dragMoveHandler: UIEventHandler

When dragging, should: Update drag preview position Update indicator position Update drop block id

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1293


_dragStartHandler

private _dragStartHandler: UIEventHandler

When start dragging, should set dragging elements and create drag preview

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1262


_isDragHandleHovered

private _isDragHandleHovered: boolean = false

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:121


_isHoverDragHandleVisible

private _isHoverDragHandleVisible: boolean = false

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:120


_isTopLevelDragHandleVisible

private _isTopLevelDragHandleVisible: boolean = false

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:122


_keyboardHandler

private _keyboardHandler: UIEventHandler

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1388


_lastHoveredBlockPath

private _lastHoveredBlockPath: null | string[] = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:117


_lastShowedBlock

private _lastShowedBlock: null | Object = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:118


_pointerMoveHandler

private _pointerMoveHandler: UIEventHandler

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:933


_pointerOutHandler

private _pointerOutHandler: UIEventHandler

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1364


_throttledPointerMoveHandler

private _throttledPointerMoveHandler: (...args) => void

Parameters

• ...args: [UIEventStateContext]

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:982


accessKey

accessKey: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.accessKey

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10053


accessKeyLabel

readonly accessKeyLabel: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.accessKeyLabel

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10055


ariaAtomic

ariaAtomic: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaAtomic

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2209


ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaAutoComplete

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2211


ariaBusy

ariaBusy: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaBusy

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2213


ariaChecked

ariaChecked: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaChecked

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2215


ariaColCount

ariaColCount: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaColCount

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2217


ariaColIndex

ariaColIndex: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaColIndex

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2219


ariaColSpan

ariaColSpan: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaColSpan

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2221


ariaCurrent

ariaCurrent: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaCurrent

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2223


ariaDisabled

ariaDisabled: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaDisabled

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2225


ariaExpanded

ariaExpanded: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaExpanded

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2227


ariaHasPopup

ariaHasPopup: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaHasPopup

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2229


ariaHidden

ariaHidden: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaHidden

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2231


ariaInvalid

ariaInvalid: null | string

Inherited from

@blocksuite/lit.WidgetElement.ariaInvalid

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2232


ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaKeyShortcuts

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2234


ariaLabel

ariaLabel: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaLabel

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2236


ariaLevel

ariaLevel: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaLevel

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2238


ariaLive

ariaLive: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaLive

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2240


ariaModal

ariaModal: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaModal

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2242


ariaMultiLine

ariaMultiLine: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaMultiLine

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2244


ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaMultiSelectable

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2246


ariaOrientation

ariaOrientation: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaOrientation

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2248


ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaPlaceholder

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2250


ariaPosInSet

ariaPosInSet: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaPosInSet

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2252


ariaPressed

ariaPressed: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaPressed

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2254


ariaReadOnly

ariaReadOnly: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaReadOnly

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2256


ariaRequired

ariaRequired: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaRequired

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2258


ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaRoleDescription

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2260


ariaRowCount

ariaRowCount: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaRowCount

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2262


ariaRowIndex

ariaRowIndex: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaRowIndex

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2264


ariaRowSpan

ariaRowSpan: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaRowSpan

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2266


ariaSelected

ariaSelected: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaSelected

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2268


ariaSetSize

ariaSetSize: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaSetSize

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2270


ariaSort

ariaSort: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaSort

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2272


ariaValueMax

ariaValueMax: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaValueMax

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2274


ariaValueMin

ariaValueMin: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaValueMin

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2276


ariaValueNow

ariaValueNow: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaValueNow

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2278


ariaValueText

ariaValueText: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ariaValueText

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2280


assignedSlot

readonly assignedSlot: null | HTMLSlotElement

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.assignedSlot

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:21296


attributeStyleMap

readonly attributeStyleMap: StylePropertyMap

Inherited from

@blocksuite/lit.WidgetElement.attributeStyleMap

Source

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


attributes

readonly attributes: NamedNodeMap

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.attributes

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7600


autocapitalize

autocapitalize: string

Inherited from

@blocksuite/lit.WidgetElement.autocapitalize

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10056


autofocus

autofocus: boolean

Inherited from

@blocksuite/lit.WidgetElement.autofocus

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:12045


baseURI

readonly baseURI: string

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.baseURI

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16074


blockElement

blockElement: PageRootBlockComponent | EdgelessRootBlockComponent

Inherited from

@blocksuite/lit.WidgetElement.blockElement

Source

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


center

center: IVec

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:106


childElementCount

readonly childElementCount: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.childElementCount

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16763


childNodes

readonly childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.childNodes

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16080


children

readonly children: HTMLCollection

Returns the child elements.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.children

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16769


classList

readonly classList: DOMTokenList

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.classList

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7606


className

className: string

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.className

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7612


clientHeight

readonly clientHeight: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.clientHeight

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7614


clientLeft

readonly clientLeft: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.clientLeft

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7616


clientTop

readonly clientTop: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.clientTop

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7618


clientWidth

readonly clientWidth: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.clientWidth

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7620


contentEditable

contentEditable: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.contentEditable

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7862


cumulativeParentScale

cumulativeParentScale: number = 1

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:105


dataset

readonly dataset: DOMStringMap

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.dataset

Source

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


dir

dir: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.dir

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10058


disposables

readonly disposables: DisposableGroup

Inherited from

@blocksuite/lit.WidgetElement.disposables

Source

packages/framework/lit/dist/with-disposable.d.ts:4


doc

doc: Doc

Inherited from

@blocksuite/lit.WidgetElement.doc

Source

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


dragPreview

dragPreview: null | DragPreview = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:100


draggable

draggable: boolean

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.draggable

Source

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


dragging

dragging: boolean = false

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:99


draggingElements

draggingElements: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[] = []

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:96


dropBlockId

dropBlockId: string = ''

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:97


dropIndicator

dropIndicator: null | DropIndicator = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:101


dropType

dropType: null | DropType = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:98


enterKeyHint

enterKeyHint: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.enterKeyHint

Source

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


firstChild

readonly firstChild: null | ChildNode

Returns the first child.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.firstChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16086


firstElementChild

readonly firstElementChild: null | Element

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.firstElementChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16775


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?: Object

options.global?: boolean

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.handleEvent

Source

packages/framework/lit/dist/element/widget-element.d.ts:19


hidden

hidden: boolean

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.hidden

Source

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


host

host: EditorHost

Inherited from

@blocksuite/lit.WidgetElement.host

Source

packages/framework/lit/dist/element/widget-element.d.ts:10


id

id: string

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.id

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7626


inert

inert: boolean

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.inert

Source

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


innerHTML

innerHTML: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.innerHTML

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:14279


innerText

innerText: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.innerText

Source

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


inputMode

inputMode: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.inputMode

Source

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


isConnected

readonly isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.isConnected

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16092


isContentEditable

readonly isContentEditable: boolean

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.isContentEditable

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7868


lang

lang: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.lang

Source

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


lastChild

readonly lastChild: null | ChildNode

Returns the last child.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.lastChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16098


lastDragPointerState

lastDragPointerState: null | PointerEventState = null

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:102


lastElementChild

readonly lastElementChild: null | Element

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.lastElementChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16781


localName

readonly localName: string

Returns the local name.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.localName

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7632


namespaceURI

readonly namespaceURI: null | string

Returns the namespace.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.namespaceURI

Source

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


nextElementSibling

readonly nextElementSibling: null | Element

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nextElementSibling

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16354


nextSibling

readonly nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nextSibling

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16104


nodeName

readonly nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nodeName

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16110


nodeType

readonly nodeType: number

Returns the type of node.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nodeType

Source

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


nodeValue

nodeValue: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nodeValue

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16118


nonce?

nonce?: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.nonce

Source

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


noteScale

noteScale: number = 1

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:104


offsetHeight

readonly offsetHeight: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.offsetHeight

Source

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


offsetLeft

readonly offsetLeft: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.offsetLeft

Source

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


offsetParent

readonly offsetParent: null | Element

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.offsetParent

Source

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


offsetTop

readonly offsetTop: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.offsetTop

Source

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


offsetWidth

readonly offsetWidth: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.offsetWidth

Source

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


onabort

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

Fires when the user aborts the download.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onabort

Source

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


onanimationcancel

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onanimationcancel

Source

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


onanimationend

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onanimationend

Source

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


onanimationiteration

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onanimationiteration

Source

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


onanimationstart

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onanimationstart

Source

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


onauxclick

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onauxclick

Source

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


onbeforeinput

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onbeforeinput

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8960


onblur

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

Fires when the object loses the input focus.

Param

The focus event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onblur

Source

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


oncancel

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncancel

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8969


oncanplay

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncanplay

Source

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


oncanplaythrough

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncanplaythrough

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8978


onchange

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onchange

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8985


onclick

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onclick

Source

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


onclose

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onclose

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8994


oncontextmenu

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncontextmenu

Source

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


oncopy

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncopy

Source

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


oncuechange

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncuechange

Source

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


oncut

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oncut

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9007


ondblclick

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

Fires when the user double-clicks the object.

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondblclick

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9014


ondrag

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

Fires on the source object continuously during a drag operation.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondrag

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9021


ondragend

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondragend

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9028


ondragenter

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

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

Param

The drag event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondragenter

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9035


ondragleave

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

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

Param

The drag event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondragleave

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9042


ondragover

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondragover

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9049


ondragstart

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondragstart

Source

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


ondrop

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondrop

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9058


ondurationchange

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

Occurs when the duration attribute is updated.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ondurationchange

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9065


onemptied

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onemptied

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9072


onended

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

Occurs when the end of playback is reached.

Param

The event

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onended

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9079


onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onerror

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9086


onfocus

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

Fires when the object receives focus.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onfocus

Source

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


onformdata

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onformdata

Source

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


onfullscreenchange

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onfullscreenchange

Source

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


onfullscreenerror

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onfullscreenerror

Source

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


ongotpointercapture

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ongotpointercapture

Source

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


oninput

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oninput

Source

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


oninvalid

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.oninvalid

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9101


onkeydown

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

Fires when the user presses a key.

Param

The keyboard event

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onkeydown

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9108


onkeypress

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

Fires when the user presses an alphanumeric key.

Param

The event.

Deprecated

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onkeypress

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9116


onkeyup

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

Fires when the user releases a key.

Param

The keyboard event

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onkeyup

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9123


onload

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

Fires immediately after the browser loads the object.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onload

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9130


onloadeddata

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onloadeddata

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9137


onloadedmetadata

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onloadedmetadata

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9144


onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onloadstart

Source

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


onlostpointercapture

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onlostpointercapture

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9153


onmousedown

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmousedown

Source

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


onmouseenter

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmouseenter

Source

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


onmouseleave

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmouseleave

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9164


onmousemove

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

Fires when the user moves the mouse over the object.

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmousemove

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9171


onmouseout

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmouseout

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9178


onmouseover

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmouseover

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9185


onmouseup

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

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

Param

The mouse event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onmouseup

Source

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


onpaste

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpaste

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9194


onpause

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

Occurs when playback is paused.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpause

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9201


onplay

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

Occurs when the play method is requested.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onplay

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9208


onplaying

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

Occurs when the audio or video has started playing.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onplaying

Source

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


onpointercancel

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointercancel

Source

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


onpointerdown

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerdown

Source

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


onpointerenter

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerenter

Source

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


onpointerleave

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerleave

Source

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


onpointermove

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointermove

Source

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


onpointerout

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerout

Source

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


onpointerover

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerover

Source

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


onpointerup

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onpointerup

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9231


onprogress

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

Occurs to indicate progress while downloading media data.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onprogress

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9238


onratechange

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

Occurs when the playback rate is increased or decreased.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onratechange

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9245


onreset

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

Fires when the user resets a form.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onreset

Source

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


onresize

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onresize

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9254


onscroll

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onscroll

Source

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


onscrollend

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onscrollend

Source

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


onsecuritypolicyviolation

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onsecuritypolicyviolation

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9265


onseeked

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

Occurs when the seek operation ends.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onseeked

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9272


onseeking

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

Occurs when the current playback position is moved.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onseeking

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9279


onselect

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

Fires when the current selection changes.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onselect

Source

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


onselectionchange

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onselectionchange

Source

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


onselectstart

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onselectstart

Source

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


onslotchange

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onslotchange

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9292


onstalled

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

Occurs when the download has stopped.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onstalled

Source

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


onsubmit

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onsubmit

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9301


onsuspend

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

Occurs if the load operation has been intentionally halted.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onsuspend

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9308


ontimeupdate

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

Occurs to indicate the current playback position.

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontimeupdate

Source

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


ontoggle

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontoggle

Source

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


ontouchcancel?

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontouchcancel

Source

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


ontouchend?

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontouchend

Source

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


ontouchmove?

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontouchmove

Source

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


ontouchstart?

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontouchstart

Source

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


ontransitioncancel

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontransitioncancel

Source

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


ontransitionend

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontransitionend

Source

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


ontransitionrun

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontransitionrun

Source

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


ontransitionstart

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.ontransitionstart

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9333


onvolumechange

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onvolumechange

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9340


onwaiting

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

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

Param

The event.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwaiting

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9347


onwebkitanimationend

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

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwebkitanimationend

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9353


onwebkitanimationiteration

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

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwebkitanimationiteration

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9359


onwebkitanimationstart

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

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwebkitanimationstart

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9365


onwebkittransitionend

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

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwebkittransitionend

Source

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


onwheel

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.onwheel

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:9373


outerHTML

outerHTML: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.outerHTML

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7644


outerText

outerText: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.outerText

Source

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


ownerDocument

readonly ownerDocument: Document

Inherited from

@blocksuite/lit.WidgetElement.ownerDocument

Source

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


parentElement

readonly parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.parentElement

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16130


parentNode

readonly parentNode: null | ParentNode

Returns the parent.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.parentNode

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16136


part

readonly part: DOMTokenList

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.part

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7647


path

path: string[]

Inherited from

@blocksuite/lit.WidgetElement.path

Source

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


popover

popover: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.popover

Source

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


prefix

readonly prefix: null | string

Returns the namespace prefix.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.prefix

Source

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


previousElementSibling

readonly previousElementSibling: null | Element

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.previousElementSibling

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16360


previousSibling

readonly previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.previousSibling

Source

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


rafID

rafID: number = 0

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:107


role

role: null | string

Inherited from

@blocksuite/lit.WidgetElement.role

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:2281


scale

scale: number = 1

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:103


scrollHeight

readonly scrollHeight: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.scrollHeight

Source

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


scrollLeft

scrollLeft: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.scrollLeft

Source

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


scrollTop

scrollTop: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.scrollTop

Source

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


scrollWidth

readonly scrollWidth: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.scrollWidth

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7661


service

service: BlockService<BlockModel<object>>

Inherited from

@blocksuite/lit.WidgetElement.service

Source

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


shadowRoot

readonly shadowRoot: null | ShadowRoot

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.shadowRoot

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7667


slot

slot: string

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

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.slot

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7673


spellcheck

spellcheck: boolean

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.spellcheck

Source

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


style

readonly style: CSSStyleDeclaration

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.style

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7857


tabIndex

tabIndex: number

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.tabIndex

Source

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


tagName

readonly tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.tagName

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7679


textContent

textContent: null | string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.textContent

Source

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


title

title: string

MDN Reference

Inherited from

@blocksuite/lit.WidgetElement.title

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10086


translate

translate: boolean

Inherited from

@blocksuite/lit.WidgetElement.translate

Source

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


[metadata]

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

Inherited from

@blocksuite/lit.WidgetElement.[metadata]

Source

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


_$litElement$

static _$litElement$: boolean

Inherited from

@blocksuite/lit.WidgetElement._$litElement$

Source

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


_initializers?

static _initializers?: Initializer[]

Inherited from

@blocksuite/lit.WidgetElement._initializers

Source

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


finalized

protected static finalized: undefined | true

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

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.finalized

Source

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


staticOptionRunner

static staticOptionRunner: DragHandleOptionsRunner

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:84


styles

static styles: CSSResult = styles

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

Note on Content Security Policy:

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

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

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

Nocollapse

Overrides

@blocksuite/lit.WidgetElement.styles

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:82


_rangeManager

get private _rangeManager(): RangeManager

Returns

RangeManager

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:834


_viewportOffset

get private _viewportOffset(): Object

Returns

Object

left

left: number

top

top: number

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:534


anchorBlockElement

get anchorBlockElement(): null | BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Returns

null | BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:145


anchorEdgelessElement

get anchorEdgelessElement(): null | EdgelessBlock<EdgelessSelectableProps>

Returns

null | EdgelessBlock<EdgelessSelectableProps>

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:150


flavour

get flavour(): string

Returns

string

Source

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


hostPath

get hostPath(): string[]

Returns

string[]

Source

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


optionRunner

get optionRunner(): DragHandleOptionsRunner

Returns

DragHandleOptionsRunner

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:129


rootElement

get rootElement(): PageRootBlockComponent | EdgelessRootBlockComponent

Returns

PageRootBlockComponent | EdgelessRootBlockComponent

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:133


selectedBlocks

get selectedBlocks(): BlockSelection[]

Returns

BlockSelection[]

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:139


std

get std(): BlockStdScope

Returns

BlockStdScope

Source

packages/framework/lit/dist/element/widget-element.d.ts:18


widgetName

get widgetName(): string

Returns

string

Source

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


_calculatePreviewOffset()

private _calculatePreviewOffset(blockElements, state): Point

Parameters

blockElements: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

state: PointerEventState

Returns

Point

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:342


_canEditing()

private _canEditing(noteBlock): boolean

Parameters

noteBlock: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Returns

boolean

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:839


_changeCursorToGrabbing()

private _changeCursorToGrabbing(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:438


_checkTopLevelBlockSelection()

private _checkTopLevelBlockSelection(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:852


_clearRaf()

private _clearRaf(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:157


_createDragPreview()

private _createDragPreview(blockElements, state, dragPreviewEl?, dragPreviewOffset?): DragPreview

Parameters

blockElements: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

state: PointerEventState

dragPreviewEl?: HTMLElement

dragPreviewOffset?: Point

Returns

DragPreview

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:351


_createDropIndicator()

private _createDropIndicator(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:277


_getBlockElementFromViewStore()

private _getBlockElementFromViewStore(path): null | BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Parameters

path: string[]

Returns

null | BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:530


_getDraggingAreaRect()

private _getDraggingAreaRect(blockElement): Rect

Parameters

blockElement: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Returns

Rect

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:729


_getDropResult()

private _getDropResult(state): null | DropResult

When dragging, should update indicator position and target drop block id

Parameters

state: PointerEventState

Returns

null | DropResult

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:167


_getHoverAreaRectTopLevelBlock()

private _getHoverAreaRectTopLevelBlock(edgelessElement): null | Rect

Parameters

edgelessElement: EdgelessBlock<EdgelessSelectableProps>

Returns

null | Rect

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:768


_getHoveredBlocks()

private _getHoveredBlocks(): BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Returns

BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:692


_getTopWithBlockElement()

private _getTopWithBlockElement(blockElement): number

Parameters

blockElement: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Returns

number

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:543


_handleAnchorModelDisposables()

private _handleAnchorModelDisposables(blockModel): void

Parameters

blockModel: BlockModel<object>

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:516


_handleEdgelessToolUpdated()

private _handleEdgelessToolUpdated(newTool): void

Parameters

newTool: EdgelessTool

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1461


_handleEdgelessViewPortUpdated()

private _handleEdgelessViewPortUpdated(__namedParameters): void

Parameters

__namedParameters: Object

__namedParameters.center: IVec

__namedParameters.zoom: number

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1469


_hide()

private _hide(force): void

Parameters

force: boolean= false

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:475


_isBlockSelected()

private _isBlockSelected(block?): boolean

Check if given blockElement is selected

Parameters

block?: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>

Returns

boolean

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:553


_onDragEnd()

private _onDragEnd(state): boolean

Parameters

state: PointerEventState

Returns

boolean

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1112


_onDragHandlePointerDown()

private _onDragHandlePointerDown(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1435


_onDragHandlePointerEnter()

private _onDragHandlePointerEnter(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1402


_onDragHandlePointerLeave()

private _onDragHandlePointerLeave(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1449


_onDragHandlePointerUp()

private _onDragHandlePointerUp(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1444


_onDragMove()

private _onDragMove(state): boolean

Parameters

state: PointerEventState

Returns

boolean

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1102


_onDragStart()

private _onDragStart(state): undefined | boolean

Parameters

state: PointerEventState

Returns

undefined | boolean

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1031


_pointerMoveOnBlock()

private _pointerMoveOnBlock(state): void

When pointer move on block, should show drag handle And update hover block id and path

Parameters

state: PointerEventState

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:895


_removeDragPreview()

private _removeDragPreview(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:431


_removeDropIndicator()

private _removeDropIndicator(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:335


_reset()

private _reset(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:494


_resetCursor()

private _resetCursor(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:442


_resetDropResult()

private _resetDropResult(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:271


_setSelectedBlocks()

private _setSelectedBlocks(blockElements, noteId?): void

Parameters

blockElements: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

noteId?: string

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:806


_showDragHandleOnHoverBlock()

private _showDragHandleOnHoverBlock(blockPath): void

Parameters

blockPath: string[]

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:562


_showDragHandleOnTopLevelBlocks()

private _showDragHandleOnTopLevelBlocks(): Promise<void>

Returns

Promise<void>

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:638


_startDragging()

private _startDragging(blockElements, state, dragPreviewEl?, dragPreviewOffset?): void

Parameters

blockElements: BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

state: PointerEventState

dragPreviewEl?: HTMLElement

dragPreviewOffset?: Point

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:446


_updateDragHoverRectTopLevelBlock()

private _updateDragHoverRectTopLevelBlock(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:795


_updateDragPreviewOnViewportUpdate()

private _updateDragPreviewOnViewportUpdate(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:425


_updateDragPreviewPosition()

private _updateDragPreviewPosition(state): void

Parameters

state: PointerEventState

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:389


_updateDropIndicator()

private _updateDropIndicator(state, shouldAutoScroll): void

Parameters

state: PointerEventState

shouldAutoScroll: boolean= false

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:284


_updateDropIndicatorOnScroll()

private _updateDropIndicatorOnScroll(): void

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:321


_updateDropResult()

private _updateDropResult(dropResult): void

Parameters

dropResult: null | DropResult

Returns

void

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:241


addEventListener()

addEventListener(type, listener, options)

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

Type parameters

K extends keyof HTMLElementEventMap

Parameters

type: K

listener: (this, ev) => any

options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.addEventListener

Source

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

addEventListener(type, listener, options)

addEventListener(type, listener, options?): void

Parameters

type: string

listener: EventListenerOrEventListenerObject

options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.addEventListener

Source

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


after()

after(...nodes): void

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

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

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.after

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:5599


animate()

animate(keyframes, options?): Animation

MDN Reference

Parameters

keyframes: null | Keyframe[] | PropertyIndexedKeyframes

options?: number | KeyframeAnimationOptions

Returns

Animation

Inherited from

@blocksuite/lit.WidgetElement.animate

Source

node_modules/.pnpm/typescript@5.3.3/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.

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.append

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16789


appendChild()

appendChild<T>(node): T

MDN Reference

Type parameters

T extends Node

Parameters

node: T

Returns

T

Inherited from

@blocksuite/lit.WidgetElement.appendChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16146


attachInternals()

attachInternals(): ElementInternals

MDN Reference

Returns

ElementInternals

Inherited from

@blocksuite/lit.WidgetElement.attachInternals

Source

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


attachShadow()

attachShadow(init): ShadowRoot

Creates a shadow root for element and returns it.

MDN Reference

Parameters

init: ShadowRootInit

Returns

ShadowRoot

Inherited from

@blocksuite/lit.WidgetElement.attachShadow

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7685


before()

before(...nodes): void

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

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

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.before

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:5607


bindHotKey()

bindHotKey(keymap, options?): void

Parameters

keymap: Record<string, UIEventHandler>

options?: Object

options.global?: boolean

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.bindHotKey

Source

packages/framework/lit/dist/element/widget-element.d.ts:22


blur()

blur(): void

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.blur

Source

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


checkVisibility()

checkVisibility(options?): boolean

Parameters

options?: CheckVisibilityOptions

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.checkVisibility

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7686


click()

click(): void

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.click

Source

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


cloneNode()

cloneNode(deep?): Node

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

MDN Reference

Parameters

deep?: boolean

Returns

Node

Inherited from

@blocksuite/lit.WidgetElement.cloneNode

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16152


closest()

closest(selector)

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

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

MDN Reference

Type parameters

K extends keyof HTMLElementTagNameMap

Parameters

selector: K

Returns

null | HTMLElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.closest

Source

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

closest(selector)

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

Type parameters

K extends keyof SVGElementTagNameMap

Parameters

selector: K

Returns

null | SVGElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.closest

Source

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

closest(selector)

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

Type parameters

K extends keyof MathMLElementTagNameMap

Parameters

selector: K

Returns

null | MathMLElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.closest

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7694

closest(selectors)

closest<E>(selectors): null | E

Type parameters

E extends Element = Element

Parameters

selectors: string

Returns

null | E

Inherited from

@blocksuite/lit.WidgetElement.closest

Source

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


compareDocumentPosition()

compareDocumentPosition(other): number

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

MDN Reference

Parameters

other: Node

Returns

number

Inherited from

@blocksuite/lit.WidgetElement.compareDocumentPosition

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16158


computedStyleMap()

computedStyleMap(): StylePropertyMapReadOnly

MDN Reference

Returns

StylePropertyMapReadOnly

Inherited from

@blocksuite/lit.WidgetElement.computedStyleMap

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7697


connectedCallback()

connectedCallback(): void

Returns

void

Overrides

@blocksuite/lit.WidgetElement.connectedCallback

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1603


contains()

contains(other): boolean

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

MDN Reference

Parameters

other: null | Node

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.contains

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16164


disconnectedCallback()

disconnectedCallback(): void

Returns

void

Overrides

@blocksuite/lit.WidgetElement.disconnectedCallback

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1621


dispatchEvent()

dispatchEvent(event): boolean

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

MDN Reference

Parameters

event: Event

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.dispatchEvent

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:8217


firstUpdated()

firstUpdated(): void

Invoked when the element is first updated. Implement to perform one time work on the element after update.

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

Returns

void

Overrides

@blocksuite/lit.WidgetElement.firstUpdated

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1494


focus()

focus(options?): void

MDN Reference

Parameters

options?: FocusOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.focus

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:12055


getAnimations()

getAnimations(options?): Animation[]

MDN Reference

Parameters

options?: GetAnimationsOptions

Returns

Animation[]

Inherited from

@blocksuite/lit.WidgetElement.getAnimations

Source

node_modules/.pnpm/typescript@5.3.3/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.

MDN Reference

Parameters

qualifiedName: string

Returns

null | string

Inherited from

@blocksuite/lit.WidgetElement.getAttribute

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7703


getAttributeNS()

getAttributeNS(namespace, localName): null | string

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

MDN Reference

Parameters

namespace: null | string

localName: string

Returns

null | string

Inherited from

@blocksuite/lit.WidgetElement.getAttributeNS

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7709


getAttributeNames()

getAttributeNames(): string[]

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

MDN Reference

Returns

string[]

Inherited from

@blocksuite/lit.WidgetElement.getAttributeNames

Source

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


getAttributeNode()

getAttributeNode(qualifiedName): null | Attr

MDN Reference

Parameters

qualifiedName: string

Returns

null | Attr

Inherited from

@blocksuite/lit.WidgetElement.getAttributeNode

Source

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


getAttributeNodeNS()

getAttributeNodeNS(namespace, localName): null | Attr

MDN Reference

Parameters

namespace: null | string

localName: string

Returns

null | Attr

Inherited from

@blocksuite/lit.WidgetElement.getAttributeNodeNS

Source

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


getBoundingClientRect()

getBoundingClientRect(): DOMRect

MDN Reference

Returns

DOMRect

Inherited from

@blocksuite/lit.WidgetElement.getBoundingClientRect

Source

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


getClientRects()

getClientRects(): DOMRectList

MDN Reference

Returns

DOMRectList

Inherited from

@blocksuite/lit.WidgetElement.getClientRects

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7723


getElementsByClassName()

getElementsByClassName(classNames): HTMLCollectionOf<Element>

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

MDN Reference

Parameters

classNames: string

Returns

HTMLCollectionOf<Element>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByClassName

Source

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


getElementsByTagName()

getElementsByTagName(qualifiedName)

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

MDN Reference

Type parameters

K extends keyof HTMLElementTagNameMap

Parameters

qualifiedName: K

Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagName

Source

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

getElementsByTagName(qualifiedName)

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

Type parameters

K extends keyof SVGElementTagNameMap

Parameters

qualifiedName: K

Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagName

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7732

getElementsByTagName(qualifiedName)

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

Type parameters

K extends keyof MathMLElementTagNameMap

Parameters

qualifiedName: K

Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagName

Source

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

getElementsByTagName(qualifiedName)

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

Type parameters

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

qualifiedName: K

Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagName

Deprecated
Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7735

getElementsByTagName(qualifiedName)

getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Parameters

qualifiedName: string

Returns

HTMLCollectionOf<Element>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagName

Source

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


getElementsByTagNameNS()

getElementsByTagNameNS(namespaceURI, localName)

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

MDN Reference

Parameters

namespaceURI: "http://www.w3.org/1999/xhtml"

localName: string

Returns

HTMLCollectionOf<HTMLElement>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagNameNS

Source

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

getElementsByTagNameNS(namespaceURI, localName)

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Parameters

namespaceURI: "http://www.w3.org/2000/svg"

localName: string

Returns

HTMLCollectionOf<SVGElement>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagNameNS

Source

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

getElementsByTagNameNS(namespaceURI, localName)

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

Parameters

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

localName: string

Returns

HTMLCollectionOf<MathMLElement>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagNameNS

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7740

getElementsByTagNameNS(namespace, localName)

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Parameters

namespace: null | string

localName: string

Returns

HTMLCollectionOf<Element>

Inherited from

@blocksuite/lit.WidgetElement.getElementsByTagNameNS

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7741


getRootNode()

getRootNode(options?): Node

Returns node's root.

MDN Reference

Parameters

options?: GetRootNodeOptions

Returns

Node

Inherited from

@blocksuite/lit.WidgetElement.getRootNode

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16170


hasAttribute()

hasAttribute(qualifiedName): boolean

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

MDN Reference

Parameters

qualifiedName: string

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.hasAttribute

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7747


hasAttributeNS()

hasAttributeNS(namespace, localName): boolean

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

MDN Reference

Parameters

namespace: null | string

localName: string

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.hasAttributeNS

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7753


hasAttributes()

hasAttributes(): boolean

Returns true if element has attributes, and false otherwise.

MDN Reference

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.hasAttributes

Source

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


hasChildNodes()

hasChildNodes(): boolean

Returns whether node has children.

MDN Reference

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.hasChildNodes

Source

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


hasPointerCapture()

hasPointerCapture(pointerId): boolean

MDN Reference

Parameters

pointerId: number

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.hasPointerCapture

Source

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


hidePopover()

hidePopover(): void

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.hidePopover

Source

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


insertAdjacentElement()

insertAdjacentElement(where, element): null | Element

MDN Reference

Parameters

where: InsertPosition

element: Element

Returns

null | Element

Inherited from

@blocksuite/lit.WidgetElement.insertAdjacentElement

Source

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


insertAdjacentHTML()

insertAdjacentHTML(position, text): void

MDN Reference

Parameters

position: InsertPosition

text: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.insertAdjacentHTML

Source

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


insertAdjacentText()

insertAdjacentText(where, data): void

MDN Reference

Parameters

where: InsertPosition

data: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.insertAdjacentText

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7767


insertBefore()

insertBefore<T>(node, child): T

MDN Reference

Type parameters

T extends Node

Parameters

node: T

child: null | Node

Returns

T

Inherited from

@blocksuite/lit.WidgetElement.insertBefore

Source

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


isDefaultNamespace()

isDefaultNamespace(namespace): boolean

MDN Reference

Parameters

namespace: null | string

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.isDefaultNamespace

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16180


isEqualNode()

isEqualNode(otherNode): boolean

Returns whether node and otherNode have the same properties.

MDN Reference

Parameters

otherNode: null | Node

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.isEqualNode

Source

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


isSameNode()

isSameNode(otherNode): boolean

MDN Reference

Parameters

otherNode: null | Node

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.isSameNode

Source

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


lookupNamespaceURI()

lookupNamespaceURI(prefix): null | string

MDN Reference

Parameters

prefix: null | string

Returns

null | string

Inherited from

@blocksuite/lit.WidgetElement.lookupNamespaceURI

Source

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


lookupPrefix()

lookupPrefix(namespace): null | string

MDN Reference

Parameters

namespace: null | string

Returns

null | string

Inherited from

@blocksuite/lit.WidgetElement.lookupPrefix

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16192


matches()

matches(selectors): boolean

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

MDN Reference

Parameters

selectors: string

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.matches

Source

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


normalize()

normalize(): void

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

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.normalize

Source

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


prepend()

prepend(...nodes): void

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

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

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.prepend

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16797


querySelector()

querySelector(selectors)

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

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

MDN Reference

Type parameters

K extends keyof HTMLElementTagNameMap

Parameters

selectors: K

Returns

null | HTMLElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.querySelector

Source

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

querySelector(selectors)

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

Type parameters

K extends keyof SVGElementTagNameMap

Parameters

selectors: K

Returns

null | SVGElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.querySelector

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16804

querySelector(selectors)

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

Type parameters

K extends keyof MathMLElementTagNameMap

Parameters

selectors: K

Returns

null | MathMLElementTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.querySelector

Source

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

querySelector(selectors)

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

Type parameters

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors: K

Returns

null | HTMLElementDeprecatedTagNameMap[K]

Inherited from

@blocksuite/lit.WidgetElement.querySelector

Deprecated
Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16807

querySelector(selectors)

querySelector<E>(selectors): null | E

Type parameters

E extends Element = Element

Parameters

selectors: string

Returns

null | E

Inherited from

@blocksuite/lit.WidgetElement.querySelector

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16808


querySelectorAll()

querySelectorAll(selectors)

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

Returns all element descendants of node that match selectors.

MDN Reference

Type parameters

K extends keyof HTMLElementTagNameMap

Parameters

selectors: K

Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.querySelectorAll

Source

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

querySelectorAll(selectors)

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

Type parameters

K extends keyof SVGElementTagNameMap

Parameters

selectors: K

Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.querySelectorAll

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16815

querySelectorAll(selectors)

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

Type parameters

K extends keyof MathMLElementTagNameMap

Parameters

selectors: K

Returns

NodeListOf<MathMLElementTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.querySelectorAll

Source

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

querySelectorAll(selectors)

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

Type parameters

K extends keyof HTMLElementDeprecatedTagNameMap

Parameters

selectors: K

Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Inherited from

@blocksuite/lit.WidgetElement.querySelectorAll

Deprecated
Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16818

querySelectorAll(selectors)

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

Type parameters

E extends Element = Element

Parameters

selectors: string

Returns

NodeListOf<E>

Inherited from

@blocksuite/lit.WidgetElement.querySelectorAll

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16819


releasePointerCapture()

releasePointerCapture(pointerId): void

MDN Reference

Parameters

pointerId: number

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.releasePointerCapture

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7775


remove()

remove(): void

Removes node.

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.remove

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:5613


removeAttribute()

removeAttribute(qualifiedName): void

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

MDN Reference

Parameters

qualifiedName: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.removeAttribute

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7781


removeAttributeNS()

removeAttributeNS(namespace, localName): void

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

MDN Reference

Parameters

namespace: null | string

localName: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.removeAttributeNS

Source

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


removeAttributeNode()

removeAttributeNode(attr): Attr

MDN Reference

Parameters

attr: Attr

Returns

Attr

Inherited from

@blocksuite/lit.WidgetElement.removeAttributeNode

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7789


removeChild()

removeChild<T>(child): T

MDN Reference

Type parameters

T extends Node

Parameters

child: T

Returns

T

Inherited from

@blocksuite/lit.WidgetElement.removeChild

Source

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


removeEventListener()

removeEventListener(type, listener, options)

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

Type parameters

K extends keyof HTMLElementEventMap

Parameters

type: K

listener: (this, ev) => any

options?: boolean | EventListenerOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.removeEventListener

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10100

removeEventListener(type, listener, options)

removeEventListener(type, listener, options?): void

Parameters

type: string

listener: EventListenerOrEventListenerObject

options?: boolean | EventListenerOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.removeEventListener

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:10101


render()

render(): TemplateResult<1>

Returns

TemplateResult<1>

Overrides

@blocksuite/lit.WidgetElement.render

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:1628


replaceChild()

replaceChild<T>(node, child): T

MDN Reference

Type parameters

T extends Node

Parameters

node: Node

child: T

Returns

T

Inherited from

@blocksuite/lit.WidgetElement.replaceChild

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16202


replaceChildren()

replaceChildren(...nodes): void

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

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

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.replaceChildren

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:16827


replaceWith()

replaceWith(...nodes): void

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

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

MDN Reference

Parameters

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.replaceWith

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:5621


requestFullscreen()

requestFullscreen(options?): Promise<void>

Displays element fullscreen and resolves promise when done.

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

MDN Reference

Parameters

options?: FullscreenOptions

Returns

Promise<void>

Inherited from

@blocksuite/lit.WidgetElement.requestFullscreen

Source

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


requestPointerLock()

requestPointerLock(): void

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.requestPointerLock

Source

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


scroll()

scroll(options)

scroll(options?): void

MDN Reference

Parameters

options?: ScrollToOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scroll

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7801

scroll(x, y)

scroll(x, y): void

Parameters

x: number

y: number

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scroll

Source

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


scrollBy()

scrollBy(options)

scrollBy(options?): void

MDN Reference

Parameters

options?: ScrollToOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scrollBy

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7804

scrollBy(x, y)

scrollBy(x, y): void

Parameters

x: number

y: number

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scrollBy

Source

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


scrollIntoView()

scrollIntoView(arg?): void

MDN Reference

Parameters

arg?: boolean | ScrollIntoViewOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scrollIntoView

Source

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


scrollTo()

scrollTo(options)

scrollTo(options?): void

MDN Reference

Parameters

options?: ScrollToOptions

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scrollTo

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7809

scrollTo(x, y)

scrollTo(x, y): void

Parameters

x: number

y: number

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.scrollTo

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7810


setAttribute()

setAttribute(qualifiedName, value): void

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

MDN Reference

Parameters

qualifiedName: string

value: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.setAttribute

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7816


setAttributeNS()

setAttributeNS(namespace, qualifiedName, value): void

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

MDN Reference

Parameters

namespace: null | string

qualifiedName: string

value: string

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.setAttributeNS

Source

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


setAttributeNode()

setAttributeNode(attr): null | Attr

MDN Reference

Parameters

attr: Attr

Returns

null | Attr

Inherited from

@blocksuite/lit.WidgetElement.setAttributeNode

Source

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


setAttributeNodeNS()

setAttributeNodeNS(attr): null | Attr

MDN Reference

Parameters

attr: Attr

Returns

null | Attr

Inherited from

@blocksuite/lit.WidgetElement.setAttributeNodeNS

Source

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


setPointerCapture()

setPointerCapture(pointerId): void

MDN Reference

Parameters

pointerId: number

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.setPointerCapture

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7828


showPopover()

showPopover(): void

MDN Reference

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.showPopover

Source

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


toggleAttribute()

toggleAttribute(qualifiedName, force?): boolean

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

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

MDN Reference

Parameters

qualifiedName: string

force?: boolean

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.toggleAttribute

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7836


togglePopover()

togglePopover(force?): void

MDN Reference

Parameters

force?: boolean

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.togglePopover

Source

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


webkitMatchesSelector()

webkitMatchesSelector(selectors): boolean

Parameters

selectors: string

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.webkitMatchesSelector

Deprecated

This is a legacy alias of matches.

MDN Reference

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.dom.d.ts:7842


addInitializer()

static addInitializer(initializer): void

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

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

ts
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:

ts
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

@blocksuite/lit.WidgetElement.addInitializer

Nocollapse

Source

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


finalize()

protected static finalize(): void

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

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

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.finalize

Nocollapse

Source

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


registerOption()

static registerOption(option): Disposable

Parameters

option: DragHandleOption

Returns

Disposable

Source

packages/blocks/src/root-block/widgets/drag-handle/drag-handle.ts:86

attributes

observedAttributes

get static observedAttributes(): string[]

Returns a list of attributes corresponding to the registered properties.

Nocollapse

Returns

string[]

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/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

@blocksuite/lit.WidgetElement.attributeChangedCallback

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/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

@blocksuite/lit.WidgetElement.addController

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/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

@blocksuite/lit.WidgetElement.removeController

Source

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

dev-mode

disableWarning?

static disableWarning?: (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:

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

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

Parameters

warningKind: WarningKind

Returns

void

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.disableWarning

Source

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


enableWarning?

static enableWarning?: (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:

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

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

Parameters

warningKind: WarningKind

Returns

void

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.enableWarning

Source

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


enabledWarnings?

static enabledWarnings?: WarningKind[]

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

This property is only used in development builds.

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.enabledWarnings

Source

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

properties

elementProperties

static elementProperties: PropertyDeclarationMap

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

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.elementProperties

Source

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


properties

static properties: PropertyDeclarations

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

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

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

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

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.properties

Source

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


createProperty()

static createProperty(name, options?): void

Creates a property accessor on the element prototype if one does not exist and stores a [PropertyDeclaration]([object Object]) 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:

ts
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

@blocksuite/lit.WidgetElement.createProperty

Nocollapse

Source

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


getPropertyDescriptor()

protected static getPropertyDescriptor(name, key, options): undefined | PropertyDescriptor

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

ts
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

@blocksuite/lit.WidgetElement.getPropertyDescriptor

Nocollapse

Source

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


getPropertyOptions()

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

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

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

Parameters

name: PropertyKey

Returns

PropertyDeclaration<unknown, unknown>

Inherited from

@blocksuite/lit.WidgetElement.getPropertyOptions

Nocollapse

Final

Source

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

rendering

renderOptions

readonly renderOptions: RenderOptions

Inherited from

@blocksuite/lit.WidgetElement.renderOptions

Source

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


renderRoot

readonly renderRoot: HTMLElement | DocumentFragment

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

Inherited from

@blocksuite/lit.WidgetElement.renderRoot

Source

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


shadowRootOptions

static shadowRootOptions: ShadowRootInit

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

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

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.shadowRootOptions

Source

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


createRenderRoot()

protected createRenderRoot(): HTMLElement | DocumentFragment

Returns

HTMLElement | DocumentFragment

Inherited from

@blocksuite/lit.WidgetElement.createRenderRoot

Source

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

styles

elementStyles

static elementStyles: CSSResultOrNative[]

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

Nocollapse

Inherited from

@blocksuite/lit.WidgetElement.elementStyles

Source

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


finalizeStyles()

protected static finalizeStyles(styles?): CSSResultOrNative[]

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

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

Parameters

styles?: CSSResultGroup

Returns

CSSResultOrNative[]

Inherited from

@blocksuite/lit.WidgetElement.finalizeStyles

Nocollapse

Source

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

updates

hasUpdated

hasUpdated: boolean

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

Inherited from

@blocksuite/lit.WidgetElement.hasUpdated

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/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

@blocksuite/lit.WidgetElement.isUpdatePending

Source

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


updateComplete

get updateComplete(): Promise<boolean>

Returns a Promise that resolves when the element has completed updating. The Promise value is a boolean that is true if the element completed the update without triggering another update. The Promise result is false if a property was set inside updated(). If the Promise is rejected, an exception was thrown during the update.

To await additional asynchronous work, override the getUpdateComplete method. For example, it is sometimes useful to await a rendered element before fulfilling this Promise. To do this, first await super.getUpdateComplete(), then any subsequent state.

Returns

Promise<boolean>

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

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:669


enableUpdating()

protected enableUpdating(_requestedUpdate): void

Note, this method should be considered final and not overridden. It is overridden on the element instance with a function that triggers the first update.

Parameters

_requestedUpdate: boolean

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.enableUpdating

Source

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


getUpdateComplete()

protected getUpdateComplete(): Promise<boolean>

Override point for the updateComplete promise.

It is not safe to override the updateComplete getter directly due to a limitation in TypeScript which means it is not possible to call a superclass getter (e.g. super.updateComplete.then(...)) when the target language is ES5 (https://github.com/microsoft/TypeScript/issues/338). This method should be overridden instead. For example:

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

Returns

Promise<boolean>

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

Inherited from

@blocksuite/lit.WidgetElement.getUpdateComplete

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:693


performUpdate()

protected performUpdate(): void

Performs an element update. Note, if an exception is thrown during the update, firstUpdated and updated will not be called.

Call performUpdate() to immediately process a pending update. This should generally not be needed, but it can be done in rare cases when you need to update synchronously.

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.performUpdate

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/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

@blocksuite/lit.WidgetElement.requestUpdate

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:596


scheduleUpdate()

protected scheduleUpdate(): void | Promise<unknown>

Schedules an element update. You can override this method to change the timing of updates by returning a Promise. The update will await the returned Promise, and you should resolve the Promise to allow the update to proceed. If this method is overridden, super.scheduleUpdate() must be called.

For instance, to schedule updates to occur just before the next frame:

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

Returns

void | Promise<unknown>

Inherited from

@blocksuite/lit.WidgetElement.scheduleUpdate

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:618


shouldUpdate()

protected shouldUpdate(_changedProperties): boolean

Controls whether or not update() should be called when the element requests an update. By default, this method always returns true, but this can be customized to control when to update.

Parameters

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

Map of changed properties with old values

Returns

boolean

Inherited from

@blocksuite/lit.WidgetElement.shouldUpdate

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:702


update()

protected update(changedProperties): void

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

Parameters

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

Map of changed properties with old values

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.update

Source

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


updated()

protected updated(_changedProperties): void

Invoked whenever the element is updated. Implement to perform post-updating tasks via DOM APIs, for example, focusing an element.

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

Parameters

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

Map of changed properties with old values

Returns

void

Inherited from

@blocksuite/lit.WidgetElement.updated

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:723


willUpdate()

protected willUpdate(_changedProperties): void

Invoked before update() to compute values needed during the update.

Implement willUpdate to compute property values that depend on other properties and are used in the rest of the update process.

ts
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

@blocksuite/lit.WidgetElement.willUpdate

Source

node_modules/.pnpm/@lit+reactive-element@2.0.3/node_modules/@lit/reactive-element/development/reactive-element.d.ts:651


Generated using TypeDoc and typedoc-plugin-markdown.