BlockSuite API Documentation / @blocksuite/blocks / ListBlockSchema

Variable: ListBlockSchema

const ListBlockSchema: Object

Type declaration

model

model: Object & Object

Type declaration

flavour

flavour: "affine:list"

props

props: PropsGetter<Object>

Type declaration

checked

checked: boolean = false

collapsed

collapsed: ListCollapsed

text

text: Text

type

type: ListType

role

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

Type declaration

parent

parent: string[]

role

role: "content" = 'content'

version

version: number = 1

onUpgrade?

onUpgrade?: (data, previousVersion, latestVersion) => void

Parameters

• data: Object

• data.checked: boolean= false

• data.collapsed: ListCollapsed= undefined

• data.text: Text= undefined

• data.type: ListType= undefined

• previousVersion: number

• latestVersion: number

Returns

void

transformer?

transformer?: () => BaseBlockTransformer<Object>

Returns

BaseBlockTransformer<Object>

checked

checked: boolean = false

collapsed

collapsed: ListCollapsed

text

text: Text

type

type: ListType

version

version: number

Source

packages/blocks/src/list-block/list-model.ts:12

---

Generated using typedoc-plugin-markdown and TypeDoc