BlockSuite API Documentation / @blocksuite/store / BlockModel

Class: BlockModel<Props>

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

Extended by

• CalloutBlockModel
• CodeBlockModel
• DatabaseBlockModel
• DividerBlockModel
• ListBlockModel
• ParagraphBlockModel
• RootBlockModel
• SurfaceRefBlockModel
• TableBlockModel
• DataViewBlockModel

Type Parameters

Props

Props extends object = object

Constructors

new BlockModel()

new BlockModel<Props>(): BlockModel<Props>

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

Returns

BlockModel<Props>

Properties

_props

_props: SignaledProps<Props>

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

---

[modelLabel]

[modelLabel]: Props

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

---

childMap

childMap: ReadonlySignal<Map<string, number>>

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

---

created

created: Subject<void>

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

---

deleted

deleted: Subject<void>

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

---

id

id: string

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

---

keys

keys: string[]

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

---

pop()

pop: (prop) => void

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

Parameters

prop

keyof Props & string

Returns

void

---

propsUpdated

propsUpdated: Subject<{ key: string; }>

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

---

schema

schema: object

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

model

model: object

model.children?

optional model.children: string[] = ContentSchema

model.flavour

model.flavour: string = FlavourSchema

model.isFlatData?

optional model.isFlatData: boolean

model.parent?

optional model.parent: string[] = ParentSchema

model.props()?

optional model.props: (...args) => Record<string, any>

Parameters

args

...[InternalPrimitives, ...unknown[]]

Returns

Record<string, any>

model.role

model.role: "root" | "hub" | "content" = RoleSchema

model.toModel()?

optional model.toModel: (...args) => BlockModel<object>

Parameters

args

...unknown[]

Returns

BlockModel<object>

transformer()?

optional transformer: (...args) => BaseBlockTransformer<object>

Parameters

args

...[Map<string, unknown>, ...unknown[]]

Returns

BaseBlockTransformer<object>

version

version: number

---

stash()

stash: (prop) => void

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

Parameters

prop

keyof Props & string

Returns

void

---

yBlock

yBlock: YBlock

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

Accessors

children

Get Signature

get children(): BlockModel<object>[]

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

Returns

BlockModel<object>[]

---

doc

Get Signature

get doc(): Store

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

Returns

Store

Set Signature

set doc(doc): void

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

Parameters

doc

Store

Returns

void

---

flavour

Get Signature

get flavour(): string

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

Returns

string

---

parent

Get Signature

get parent(): null | BlockModel<object>

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

Returns

null | BlockModel<object>

---

props

Get Signature

get props(): SignaledProps<Props>

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

Returns

SignaledProps<Props>

---

role

Get Signature

get role(): "root" | "hub" | "content"

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

Returns

"root" | "hub" | "content"

---

text

Get Signature

get text(): undefined | Text

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

Returns

undefined | Text

Set Signature

set text(text): void

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

Parameters

text

Text

Returns

void

---

version

Get Signature

get version(): number

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

Returns

number

Methods

[dispose]()

[dispose](): void

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

Returns

void

---

dispose()

dispose(): void

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

Returns

void

---

firstChild()

firstChild(): null | BlockModel<object>

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

Returns

null | BlockModel<object>

---

isEmpty()

isEmpty(): boolean

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

Returns

boolean

---

lastChild()

lastChild(): null | BlockModel<object>

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

Returns

null | BlockModel<object>