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

Class: ViewStore

Defined in: packages/framework/block-std/src/view/view-store.ts:22

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

new ViewStore(std): ViewStore

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

Parameters

std

BlockStdScope

Returns

ViewStore

Inherited from

LifeCycleWatcher.constructor

Properties

std

readonly std: BlockStdScope

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

Inherited from

LifeCycleWatcher.std

---

viewUpdated

viewUpdated: Subject<ViewUpdatePayload>

Defined in: packages/framework/block-std/src/view/view-store.ts:27

---

key

readonly static key: "viewStore" = 'viewStore'

Defined in: packages/framework/block-std/src/view/view-store.ts:23

Overrides

LifeCycleWatcher.key

Accessors

views

Get Signature

get views(): BlockComponent<BlockModel<object>, BlockService, string>[]

Defined in: packages/framework/block-std/src/view/view-store.ts:29

Returns

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

Methods

created()

created(): void

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

Called when std is created.

Returns

void

Inherited from

LifeCycleWatcher.created

---

deleteBlock()

deleteBlock(node): void

Defined in: packages/framework/block-std/src/view/view-store.ts:45

Parameters

node

BlockComponent

Returns

void

---

deleteWidget()

deleteWidget(node): void

Defined in: packages/framework/block-std/src/view/view-store.ts:55

Parameters

node

WidgetComponent

Returns

void

---

getBlock()

getBlock(id): null | BlockComponent<BlockModel<object>, BlockService, string>

Defined in: packages/framework/block-std/src/view/view-store.ts:67

Parameters

id

string

Returns

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

---

getWidget()

getWidget(widgetName, hostBlockId): null | WidgetComponent<BlockModel<object>, BlockComponent<BlockModel<object>, BlockService, string>, BlockService>

Defined in: packages/framework/block-std/src/view/view-store.ts:71

Parameters

widgetName

string

hostBlockId

string

Returns

null | WidgetComponent<BlockModel<object>, BlockComponent<BlockModel<object>, BlockService, string>, BlockService>

---

mounted()

mounted(): void

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

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

Returns

void

Inherited from

LifeCycleWatcher.mounted

---

rendered()

rendered(): void

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

Called when std.render is called.

Returns

void

Inherited from

LifeCycleWatcher.rendered

---

setBlock()

setBlock(node): void

Defined in: packages/framework/block-std/src/view/view-store.ts:79

Parameters

node

BlockComponent

Returns

void

---

setWidget()

setWidget(node): void

Defined in: packages/framework/block-std/src/view/view-store.ts:92

Parameters

node

WidgetComponent

Returns

void

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/src/view/view-store.ts:140

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

Returns

void

Overrides

LifeCycleWatcher.unmounted

---

walkThrough()

walkThrough(fn, blockId?): void

Defined in: packages/framework/block-std/src/view/view-store.ts:104

Parameters

fn

(nodeView, index, parent) => undefined | null | true

blockId?

null | string

Returns

void

---

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