BlockSuite API Documentation / @blocksuite/store / Block

Class: Block

Defined in: packages/framework/store/src/model/block/block.ts:9

Constructors

new Block()

new Block(schema, yBlock, doc?, options?): Block

Defined in: packages/framework/store/src/model/block/block.ts:38

Parameters

schema

Schema

yBlock

YBlock

doc?

Store

options?

BlockOptions = {}

Returns

Block

Properties

blockViewType

blockViewType: BlockViewType = 'display'

Defined in: packages/framework/store/src/model/block/block.ts:12

---

doc?

readonly optional doc: Store

Defined in: packages/framework/store/src/model/block/block.ts:41

---

options

readonly options: BlockOptions = {}

Defined in: packages/framework/store/src/model/block/block.ts:42

---

schema

readonly schema: Schema

Defined in: packages/framework/store/src/model/block/block.ts:39

---

yBlock

readonly yBlock: YBlock

Defined in: packages/framework/store/src/model/block/block.ts:40

Accessors

flavour

Get Signature

get flavour(): string

Defined in: packages/framework/store/src/model/block/block.ts:14

Returns

string

---

id

Get Signature

get id(): string

Defined in: packages/framework/store/src/model/block/block.ts:18

Returns

string

---

model

Get Signature

get model(): BlockModel<object>

Defined in: packages/framework/store/src/model/block/block.ts:22

Returns

BlockModel<object>

---

pop

Get Signature

get pop(): (prop) => void | (prop) => void

Defined in: packages/framework/store/src/model/block/block.ts:26

Returns

(prop) => void | (prop) => void

---

stash

Get Signature

get stash(): (prop) => void | (prop) => void

Defined in: packages/framework/store/src/model/block/block.ts:30

Returns

(prop) => void | (prop) => void

---

version

Get Signature

get version(): number

Defined in: packages/framework/store/src/model/block/block.ts:34

Returns

number