API > @blocksuite/block-std > UIEventDispatcher
Class: UIEventDispatcher ​
Constructors ​
constructor ​
new UIEventDispatcher(
std):UIEventDispatcher
Parameters ​
| Parameter | Type |
|---|---|
std | BlockStdProvider |
Returns ​
Defined In ​
block-std/src/event/dispatcher.ts:80
Properties ​
_clipboardControl ​
private_clipboardControl:ClipboardControl
Defined In ​
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[] >
Defined In ​
block-std/src/event/dispatcher.ts:71
_keyboardControl ​
private_keyboardControl:KeyboardControl
Defined In ​
block-std/src/event/dispatcher.ts:76
_pointerControl ​
private_pointerControl:PointerControl
Defined In ​
block-std/src/event/dispatcher.ts:75
_rangeControl ​
private_rangeControl:RangeControl
Defined In ​
block-std/src/event/dispatcher.ts:77
disposables ​
disposables:
DisposableGroup
Defined In ​
block-std/src/event/dispatcher.ts:69
std ​
std:
BlockStdProvider
Defined In ​
block-std/src/event/dispatcher.ts:80
Accessors ​
_currentSelections ​
privateget_currentSelections():BaseSelection[]
Defined In ​
block-std/src/event/dispatcher.ts:139
root ​
getroot():HTMLElement
Defined In ​
block-std/src/event/dispatcher.ts:98
Methods ​
_bindEvents ​
private_bindEvents():void
Returns ​
void
Defined In ​
block-std/src/event/dispatcher.ts:235
_buildEventScopeBySelection ​
private_buildEventScopeBySelection(name):undefined|EventScope
Parameters ​
| Parameter | Type |
|---|---|
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
Defined In ​
block-std/src/event/dispatcher.ts:208
_buildEventScopeByTarget ​
private_buildEventScopeByTarget(name,target):undefined|EventScope
Parameters ​
| Parameter | Type |
|---|---|
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
Defined In ​
block-std/src/event/dispatcher.ts:189
_getEventScope ​
private_getEventScope(name,event):undefined|EventScope
Parameters ​
| Parameter | Type |
|---|---|
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
Defined In ​
block-std/src/event/dispatcher.ts:143
add ​
add(
name,handler,options?):function
Parameters ​
| Parameter | Type |
|---|---|
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 ​
():
voidReturns ​
voidDefined In ​
block-std/src/event/dispatcher.ts:127
Defined In ​
block-std/src/event/dispatcher.ts:120
bindHotkey ​
bindHotkey(...
args):function
Parameters ​
| Parameter | Type |
|---|---|
...args | [Record< string, UIEventHandler >, EventOptions] |
Returns ​
():
voidReturns ​
voidDefined In ​
block-std/src/event/dispatcher.ts:127
Defined In ​
block-std/src/event/dispatcher.ts:136
buildEventScope ​
buildEventScope(
name,flavours,paths):undefined|EventScope
Parameters ​
| Parameter | Type |
|---|---|
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
Defined In ​
block-std/src/event/dispatcher.ts:160
mount ​
mount():
void
Returns ​
void
Defined In ​
block-std/src/event/dispatcher.ts:87
run ​
run(
name,context,scope?):void
Parameters ​
| Parameter | Type |
|---|---|
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
Defined In ​
block-std/src/event/dispatcher.ts:102
unmount ​
unmount():
void
Returns ​
void
Defined In ​
block-std/src/event/dispatcher.ts:94