BlockSuite API Documentation / @blocksuite/store / BlockModel

Class: BlockModel<Props>

Contents

• Extends
• Type parameters
• Constructors
  • new BlockModel(undefined)
• Properties
  • childrenUpdated
  • created
  • deleted
  • flavour
  • id
  • keys
  • page
  • pop
  • propsUpdated
  • role
  • stash
  • text?
  • yBlock
• Accessors
  • childMap
  • children
• Methods
  • clone()
  • dispose()
  • firstChild()
  • isEmpty()
  • lastChild()
  • lastItem()

Extends

• Props

Type parameters

• Props extends object = object

Constructors

new BlockModel(undefined)

new BlockModel<Props>(): BlockModel<Props>

Returns

BlockModel<Props>

Inherited from

MagicProps()<Props>.constructor

Source

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

Properties

childrenUpdated

childrenUpdated: Slot<void>

Source

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

---

created

created: Slot<void>

Source

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

---

deleted

deleted: Slot<void>

Source

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

---

flavour

flavour: string

Source

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

---

id

id: string

Source

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

---

keys

keys: string[]

Source

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

---

page

page: Page

Source

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

---

pop

pop: (prop) => void

Parameters

• prop: keyof Props & string

Returns

void

Source

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

---

propsUpdated

propsUpdated: Slot<Object>

Type declaration

key

key: string

Source

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

---

role

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

Source

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

---

stash

stash: (prop) => void

Parameters

• prop: keyof Props & string

Returns

void

Source

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

---

text?

text?: Text

Source

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

---

yBlock

yBlock: YBlock

Source

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

Accessors

childMap

get childMap(): Map<string, number>

Returns

Map<string, number>

Source

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

---

children

get children(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

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

Methods

clone()

clone(): BlockModel<Props>

Returns

BlockModel<Props>

Source

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

---

dispose()

dispose(): void

Returns

void

Source

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

---

firstChild()

firstChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Source

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

---

isEmpty()

isEmpty(): boolean

Returns

boolean

Source

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

---

lastChild()

lastChild(): null | BlockModel<object>

Returns

null | BlockModel<object>

Source

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

---

lastItem()

lastItem(): null | BlockModel<object>

Returns

null | BlockModel<object>

Source

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

---

Generated using typedoc-plugin-markdown and TypeDoc