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

Class: EditorLifeCycleExtension

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:7

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 EditorLifeCycleExtension()

new EditorLifeCycleExtension(std): EditorLifeCycleExtension

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:19

Parameters

std

BlockStdScope

Returns

EditorLifeCycleExtension

Overrides

LifeCycleWatcher.constructor

Properties

disposables

disposables: DisposableGroup

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:10

---

slots

readonly slots: object

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:12

created

created: Subject<void>

mounted

mounted: Subject<void>

rendered

rendered: Subject<void>

unmounted

unmounted: Subject<void>

---

std

readonly std: BlockStdScope

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:19

Inherited from

LifeCycleWatcher.std

---

key

static key: string = 'editor-life-cycle'

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:8

Overrides

LifeCycleWatcher.key

Methods

created()

created(): void

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:28

Called when std is created.

Returns

void

Overrides

LifeCycleWatcher.created

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:33

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

Returns

void

Overrides

LifeCycleWatcher.mounted

---

rendered()

rendered(): void

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:38

Called when std.render is called.

Returns

void

Overrides

LifeCycleWatcher.rendered

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/src/extension/editor-life-cycle.ts:43

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

Returns

void

Overrides

LifeCycleWatcher.unmounted

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/src/extension/lifecycle-watcher.ts:32

Parameters

di

Container

Returns

void

Inherited from

LifeCycleWatcher.setup