BlockSuite API Documentation / @blocksuite/blocks / RootBlockModel
Class: RootBlockModel
Extends
BlockModel
<RootBlockProps
>
Constructors
new RootBlockModel(undefined)
new RootBlockModel():
RootBlockModel
Returns
Overrides
BlockModel<RootBlockProps>.constructor
Source
packages/blocks/src/root-block/root-model.ts:9
Properties
[modelLabel]
[modelLabel]:
RootBlockProps
Inherited from
BlockModel.[modelLabel]
Source
packages/framework/store/dist/schema/base.d.ts:101
childrenUpdated
childrenUpdated:
Slot
<void
>
Inherited from
BlockModel.childrenUpdated
Source
packages/framework/store/dist/schema/base.d.ts:120
created
created:
Slot
<void
>
Inherited from
BlockModel.created
Source
packages/framework/store/dist/schema/base.d.ts:115
deleted
deleted:
Slot
<void
>
Inherited from
BlockModel.deleted
Source
packages/framework/store/dist/schema/base.d.ts:116
flavour
flavour:
string
Inherited from
BlockModel.flavour
Source
packages/framework/store/dist/schema/base.d.ts:103
id
id:
string
Inherited from
BlockModel.id
Source
packages/framework/store/dist/schema/base.d.ts:109
keys
keys:
string
[]
Inherited from
BlockModel.keys
Source
packages/framework/store/dist/schema/base.d.ts:111
page
page:
Doc
Deprecated
use doc instead
Inherited from
BlockModel.page
Source
packages/framework/store/dist/schema/base.d.ts:108
pop()
pop: (
prop
) =>void
Parameters
• prop: "title"
Returns
void
Inherited from
BlockModel.pop
Source
packages/framework/store/dist/schema/base.d.ts:113
propsUpdated
propsUpdated:
Slot
<object
>
Type declaration
key
key:
string
Inherited from
BlockModel.propsUpdated
Source
packages/framework/store/dist/schema/base.d.ts:117
role
role:
"root"
|"hub"
|"content"
Inherited from
BlockModel.role
Source
packages/framework/store/dist/schema/base.d.ts:104
stash()
stash: (
prop
) =>void
Parameters
• prop: "title"
Returns
void
Inherited from
BlockModel.stash
Source
packages/framework/store/dist/schema/base.d.ts:112
text?
optional
text:Text
Inherited from
BlockModel.text
Source
packages/framework/store/dist/schema/base.d.ts:114
title
title:
Text
Inherited from
BlockModel.title
Source
packages/blocks/src/root-block/root-model.ts:5
version
version:
number
Inherited from
BlockModel.version
Source
packages/framework/store/dist/schema/base.d.ts:102
yBlock
yBlock:
YBlock
Inherited from
BlockModel.yBlock
Source
packages/framework/store/dist/schema/base.d.ts:110
Accessors
childMap
get
childMap():Map
<string
,number
>
Returns
Map
<string
, number
>
Source
packages/framework/store/dist/schema/base.d.ts:123
children
get
children():BlockModel
<object
>[]
Returns
BlockModel
<object
>[]
Source
packages/framework/store/dist/schema/base.d.ts:124
doc
get
doc():Doc
set
doc(doc
):void
Parameters
• doc: Doc
Returns
Source
packages/framework/store/dist/schema/base.d.ts:121
Methods
dispose()
dispose():
void
Returns
void
Inherited from
BlockModel.dispose
Source
packages/framework/store/dist/schema/base.d.ts:128
firstChild()
firstChild():
null
|BlockModel
<object
>
Returns
null
| BlockModel
<object
>
Inherited from
BlockModel.firstChild
Source
packages/framework/store/dist/schema/base.d.ts:126
isEmpty()
isEmpty():
boolean
Returns
boolean
Inherited from
BlockModel.isEmpty
Source
packages/framework/store/dist/schema/base.d.ts:125
lastChild()
lastChild():
null
|BlockModel
<object
>
Returns
null
| BlockModel
<object
>
Inherited from
BlockModel.lastChild
Source
packages/framework/store/dist/schema/base.d.ts:127