Skip to content

BlockSuite API Documentation / @blocksuite/store / BaseBlockModel

Class: BaseBlockModel<Props> ​

Contents ​

Extends ​

  • Props

Type parameters ​

• Props extends object = object

Constructors ​

new BaseBlockModel(undefined) ​

new BaseBlockModel<Props>(): BaseBlockModel<Props>

Returns ​

BaseBlockModel<Props>

Inherited from ​

MagicProps()<Props>.constructor

Source ​

packages/store/src/schema/base.ts:168

Properties ​

childrenUpdated ​

childrenUpdated: Slot<void>

Source ​

packages/store/src/schema/base.ts:194


created ​

created: Slot<void>

Source ​

packages/store/src/schema/base.ts:191


deleted ​

deleted: Slot<void>

Source ​

packages/store/src/schema/base.ts:192


flavour ​

flavour: string

Source ​

packages/store/src/schema/base.ts:178


id ​

id: string

Source ​

packages/store/src/schema/base.ts:181


keys ​

keys: string[]

Source ​

packages/store/src/schema/base.ts:183


page ​

page: Page

Source ​

packages/store/src/schema/base.ts:180


pop ​

pop: (prop) => void

Parameters ​

• prop: keyof Props & string

Returns ​

void

Source ​

packages/store/src/schema/base.ts:186


propsUpdated ​

propsUpdated: Slot<Object>

Type declaration ​

key ​

key: string

Source ​

packages/store/src/schema/base.ts:193


role ​

role: "root" | "hub" | "content"

Source ​

packages/store/src/schema/base.ts:179


stash ​

stash: (prop) => void

Parameters ​

• prop: keyof Props & string

Returns ​

void

Source ​

packages/store/src/schema/base.ts:185


text? ​

text?: Text

Source ​

packages/store/src/schema/base.ts:189


yBlock ​

yBlock: YBlock

Source ​

packages/store/src/schema/base.ts:182

Accessors ​

childMap ​

get childMap(): Map<string, number>

Returns ​

Map<string, number>

Source ​

packages/store/src/schema/base.ts:196


children ​

get children(): BaseBlockModel<object>[]

Returns ​

BaseBlockModel<object>[]

Source ​

packages/store/src/schema/base.ts:203

Methods ​

clone() ​

clone(): BaseBlockModel<Props>

Returns ​

BaseBlockModel<Props>

Source ​

packages/store/src/schema/base.ts:250


dispose() ​

dispose(): void

Returns ​

void

Source ​

packages/store/src/schema/base.ts:243


firstChild() ​

firstChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/schema/base.ts:225


isEmpty() ​

isEmpty(): boolean

Returns ​

boolean

Source ​

packages/store/src/schema/base.ts:221


lastChild() ​

lastChild(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/schema/base.ts:229


lastItem() ​

lastItem(): null | BaseBlockModel<object>

Returns ​

null | BaseBlockModel<object>

Source ​

packages/store/src/schema/base.ts:236


Generated using typedoc-plugin-markdown and TypeDoc