BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/block-std / UIEventDispatcher

Class: UIEventDispatcher ​

Contents ​

Constructors ​

new UIEventDispatcher(std) ​

new UIEventDispatcher(std): UIEventDispatcher

Parameters ​

• std: BlockStdScope

Returns ​

UIEventDispatcher

Source ​

block-std/src/event/dispatcher.ts:80

Properties ​

_clipboardControl ​

private _clipboardControl: ClipboardControl

Source ​

block-std/src/event/dispatcher.ts:78

_handlersMap ​

private _handlersMap: Record<"cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu", EventHandlerRunner[]>

Source ​

block-std/src/event/dispatcher.ts:71

_keyboardControl ​

private _keyboardControl: KeyboardControl

Source ​

block-std/src/event/dispatcher.ts:76

_pointerControl ​

private _pointerControl: PointerControl

Source ​

block-std/src/event/dispatcher.ts:75

_rangeControl ​

private _rangeControl: RangeControl

Source ​

block-std/src/event/dispatcher.ts:77

disposables ​

disposables: DisposableGroup

Source ​

block-std/src/event/dispatcher.ts:69

std ​

std: BlockStdScope

Source ​

block-std/src/event/dispatcher.ts:80

_activeDispatcher ​

private static _activeDispatcher: null | UIEventDispatcher = null

Source ​

block-std/src/event/dispatcher.ts:87

Accessors ​

_currentSelections ​

get private _currentSelections(): BaseSelection[]

Returns ​

BaseSelection[]

Source ​

block-std/src/event/dispatcher.ts:160

host ​

get host(): HTMLElement

Returns ​

HTMLElement

Source ​

block-std/src/event/dispatcher.ts:119

isActive ​

get isActive(): boolean

Returns ​

boolean

Source ​

block-std/src/event/dispatcher.ts:89

Methods ​

_bindEvents() ​

private _bindEvents(): void

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:256

_buildEventScopeBySelection() ​

private _buildEventScopeBySelection(name): undefined | EventScope

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

Returns ​

undefined | EventScope

Source ​

block-std/src/event/dispatcher.ts:229

_buildEventScopeByTarget() ​

private _buildEventScopeByTarget(name, target): undefined | EventScope

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

• target: Node

Returns ​

undefined | EventScope

Source ​

block-std/src/event/dispatcher.ts:210

_getEventScope() ​

private _getEventScope(name, event): undefined | EventScope

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

• event: Event

Returns ​

undefined | EventScope

Source ​

block-std/src/event/dispatcher.ts:164

activate() ​

activate(): void

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:93

add() ​

add(name, handler, options?): () => void

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

• handler: UIEventHandler

• options?: EventOptions

Returns ​

Function

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:141

bindHotkey() ​

bindHotkey(...args): () => void

Parameters ​

• ...args: [Record<string, UIEventHandler>, EventOptions]

Returns ​

Function

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:157

buildEventScope() ​

buildEventScope(name, flavours, paths): undefined | EventScope

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

• flavours: string[]

• paths: string[][]

Returns ​

undefined | EventScope

Source ​

block-std/src/event/dispatcher.ts:181

deactivate() ​

deactivate(): void

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:100

mount() ​

mount(): void

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:108

run() ​

run(name, context, scope?): void

Parameters ​

• name: "cut" | "blur" | "click" | "copy" | "drop" | "focus" | "paste" | "wheel" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "beforeInput" | "contextMenu"

• context: UIEventStateContext

• scope?: EventScope

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:123

unmount() ​

unmount(): void

Returns ​

void

Source ​

block-std/src/event/dispatcher.ts:115

Generated using typedoc-plugin-markdown and TypeDoc

Copyright © 2022-present Toeverything