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

Class: UIEventDispatcher

A life cycle watcher is an extension that watches the life cycle of the editor. It is used to perform actions when the editor is created, mounted, rendered, or unmounted.

When creating a life cycle watcher, you must define a key that is unique to the watcher. The key is used to identify the watcher in the dependency injection container.

class MyLifeCycleWatcher extends LifeCycleWatcher {
 static override readonly key = 'my-life-cycle-watcher';

In the life cycle watcher, the methods will be called in the following order:

1. created: Called when the std is created.
2. rendered: Called when std.render is called.
3. mounted: Called when the editor host is mounted.
4. unmounted: Called when the editor host is unmounted.

Extends

• LifeCycleWatcher

Constructors

new UIEventDispatcher()

new UIEventDispatcher(std): UIEventDispatcher

Parameters

std

BlockStdScope

Returns

UIEventDispatcher

Overrides

LifeCycleWatcher.constructor

Defined in

packages/framework/block-std/src/event/dispatcher.ts:112

Properties

disposables

disposables: DisposableGroup

Defined in

packages/framework/block-std/src/event/dispatcher.ts:98

---

std

readonly std: BlockStdScope

Inherited from

LifeCycleWatcher.std

Defined in

packages/framework/block-std/src/extension/lifecycle-watcher.ts:30

---

key

readonly static key: "UIEventDispatcher" = 'UIEventDispatcher'

Overrides

LifeCycleWatcher.key

Defined in

packages/framework/block-std/src/event/dispatcher.ts:79

Accessors

active

Get Signature

get active(): boolean

Returns

boolean

Defined in

packages/framework/block-std/src/event/dispatcher.ts:104

---

host

Get Signature

get host(): EditorHost

Returns

EditorHost

Defined in

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

Methods

add()

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

Parameters

name

"blur" | "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "focus" | "contextMenu" | "wheel"

handler

UIEventHandler

options?

EventOptions

Returns

Function

Returns

void

Defined in

packages/framework/block-std/src/event/dispatcher.ts:305

---

bindHotkey()

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

Parameters

args

...[Record<string, UIEventHandler>, EventOptions]

Returns

Function

Returns

void

Defined in

packages/framework/block-std/src/event/dispatcher.ts:95

---

buildEventScope()

buildEventScope(name, blocks): undefined | EventHandlerRunner[]

Parameters

name

"blur" | "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "focus" | "contextMenu" | "wheel"

blocks

string[]

Returns

undefined | EventHandlerRunner[]

Defined in

packages/framework/block-std/src/event/dispatcher.ts:321

---

created()

created(): void

Called when std is created.

Returns

void

Inherited from

LifeCycleWatcher.created

Defined in

packages/framework/block-std/src/extension/lifecycle-watcher.ts:54

---

mounted()

mounted(): void

Called when editor host is mounted. Which means the editor host emit the connectedCallback lifecycle event.

Returns

void

Overrides

LifeCycleWatcher.mounted

Defined in

packages/framework/block-std/src/event/dispatcher.ts:364

---

rendered()

rendered(): void

Called when std.render is called.

Returns

void

Inherited from

LifeCycleWatcher.rendered

Defined in

packages/framework/block-std/src/extension/lifecycle-watcher.ts:65

---

run()

run(name, context, runners?): void

Parameters

name

"blur" | "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "beforeInput" | "focus" | "contextMenu" | "wheel"

context

UIEventStateContext

runners?

EventHandlerRunner[]

Returns

void

Defined in

packages/framework/block-std/src/event/dispatcher.ts:378

---

unmounted()

unmounted(): void

Called when editor host is unmounted. Which means the editor host emit the disconnectedCallback lifecycle event.

Returns

void

Overrides

LifeCycleWatcher.unmounted

Defined in

packages/framework/block-std/src/event/dispatcher.ts:402

---

setup()

static setup(di): void

Parameters

di

Container

Returns

void

Inherited from

LifeCycleWatcher.setup

Defined in

packages/framework/block-std/src/extension/lifecycle-watcher.ts:34