Skip to content

BlockSuite API Documentation / @blocksuite/blocks / RootBlockModel

Class: RootBlockModel

Extends

Constructors

new RootBlockModel()

new RootBlockModel(): RootBlockModel

Returns

RootBlockModel

Overrides

BlockModel<RootBlockProps>.constructor

Defined in

packages/affine/model/dist/blocks/root/root-block-model.d.ts:7

Properties

[modelLabel]

[modelLabel]: RootBlockProps

Inherited from

BlockModel.[modelLabel]

Defined in

packages/framework/store/dist/schema/base.d.ts:115


childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

BlockModel.childMap

Defined in

packages/framework/store/dist/schema/base.d.ts:108


created

created: Slot<void>

Inherited from

BlockModel.created

Defined in

packages/framework/store/dist/schema/base.d.ts:109


deleted

deleted: Slot<void>

Inherited from

BlockModel.deleted

Defined in

packages/framework/store/dist/schema/base.d.ts:110


flavour

flavour: string

Inherited from

BlockModel.flavour

Defined in

packages/framework/store/dist/schema/base.d.ts:111


id

id: string

Inherited from

BlockModel.id

Defined in

packages/framework/store/dist/schema/base.d.ts:112


isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

BlockModel.isEmpty

Defined in

packages/framework/store/dist/schema/base.d.ts:113


keys

keys: string[]

Inherited from

BlockModel.keys

Defined in

packages/framework/store/dist/schema/base.d.ts:114


page

page: Doc

Deprecated

use doc instead

Inherited from

BlockModel.page

Defined in

packages/framework/store/dist/schema/base.d.ts:104


pop()

pop: (prop) => void

Parameters

prop

"title"

Returns

void

Inherited from

BlockModel.pop

Defined in

packages/framework/store/dist/schema/base.d.ts:116


propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

BlockModel.propsUpdated

Defined in

packages/framework/store/dist/schema/base.d.ts:117


role

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

Inherited from

BlockModel.role

Defined in

packages/framework/store/dist/schema/base.d.ts:120


stash()

stash: (prop) => void

Parameters

prop

"title"

Returns

void

Inherited from

BlockModel.stash

Defined in

packages/framework/store/dist/schema/base.d.ts:121


text?

optional text: Text

Inherited from

BlockModel.text

Defined in

packages/framework/store/dist/schema/base.d.ts:122


title

title: Text

Inherited from

BlockModel.title

Defined in

packages/affine/model/dist/blocks/root/root-block-model.d.ts:4


title$

title$: Signal<Text>

Inherited from

BlockModel.title$


version

version: number

Inherited from

BlockModel.version

Defined in

packages/framework/store/dist/schema/base.d.ts:123


yBlock

yBlock: YBlock

Inherited from

BlockModel.yBlock

Defined in

packages/framework/store/dist/schema/base.d.ts:124

Accessors

children

Get Signature

get children(): BlockModel<object, SignaledProps<object>>[]

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

BlockModel.children

Defined in

packages/framework/store/dist/schema/base.d.ts:125


doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters
doc

Doc

Returns

void

Inherited from

BlockModel.doc

Defined in

packages/framework/store/dist/schema/base.d.ts:126


parent

Get Signature

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

BlockModel.parent

Defined in

packages/framework/store/dist/schema/base.d.ts:128

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

BlockModel.[dispose]

Defined in

packages/framework/store/dist/schema/base.d.ts:133


dispose()

dispose(): void

Returns

void

Inherited from

BlockModel.dispose

Defined in

packages/framework/store/dist/schema/base.d.ts:130


firstChild()

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

BlockModel.firstChild

Defined in

packages/framework/store/dist/schema/base.d.ts:131


lastChild()

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

BlockModel.lastChild

Defined in

packages/framework/store/dist/schema/base.d.ts:132