API > @blocksuite/blocks > FrameBlockSchema
Variable: FrameBlockSchema ​
const
FrameBlockSchema:object
Type declaration ​
model
​
model: {
flavour
:"affine:frame"
;props
:PropsGetter
< {background
:string
;index
:string
;title
:Text
;xywh
:string
;} >;role
:"root"
|"hub"
|"content"
;} & {children
:never
[];parent
:string
[];role
:"content"
;version
:number
;}
model.flavour
​flavour:
"affine:frame"
model.props
​props:
PropsGetter
< {background
:string
;index
:string
;title
:Text
;xywh
:string
;} >
model.role
​role:
"root"
|"hub"
|"content"
model.children
​children:
never
[] =[]
model.parent
​parent:
string
[]
model.role
​role:
"content"
='content'
model.version
​version:
number
=1
onUpgrade
​
optional
onUpgrade:function
Parameters ​
Parameter | Type |
---|---|
data | object |
data.background | string |
data.index | string |
data.title | Text |
data.xywh | string |
previousVersion | number |
latestVersion | number |
Returns ​
void
transformer
​
optional
transformer:function
Returns ​
BaseBlockTransformer
< {background
: string
; index
: string
; title
: Text
; xywh
: string
;} >
version
​
version:
number
Defined In ​
packages/blocks/src/frame-block/frame-model.ts:22