BlockSuite API Documentation / @blocksuite/store / Doc

Class: Doc

Extends

• Space<FlatBlockMap>

Constructors

new Doc(__namedParameters)

new Doc(__namedParameters): Doc

Parameters

• __namedParameters: DocOptions

Returns

Doc

Overrides

Space.constructor

Source

packages/framework/store/src/store/doc.ts:80

Properties

_blockTree

private readonly _blockTree: BlockTree

Source

packages/framework/store/src/store/doc.ts:40

---

_collection

private readonly _collection: DocCollection

Source

packages/framework/store/src/store/doc.ts:38

---

_history

private _history: UndoManager

Source

packages/framework/store/src/store/doc.ts:41

---

_idGenerator

private readonly _idGenerator: IdGenerator

Source

packages/framework/store/src/store/doc.ts:39

---

_ready

private _ready: boolean = false

Indicate whether the block tree is ready

Source

packages/framework/store/src/store/doc.ts:44

---

_root

private _root: null | BlockModel<object> = null

Source

packages/framework/store/src/store/doc.ts:42

---

_shouldTransact

private _shouldTransact: boolean = true

Source

packages/framework/store/src/store/doc.ts:45

---

_yBlocks

protected readonly _yBlocks: Map<YBlock>

Inherited from

Space._yBlocks

Source

packages/framework/store/src/store/space.ts:28

---

_ySpaceDoc

Internal

protected readonly _ySpaceDoc: Doc

Used for convenient access to the underlying Yjs map, can be used interchangeably with ySpace

Inherited from

Space._ySpaceDoc

Source

packages/framework/store/src/store/space.ts:27

---

awarenessStore

readonly awarenessStore: AwarenessStore<BlockSuiteFlags>

Inherited from

Space.awarenessStore

Source

packages/framework/store/src/store/space.ts:17

---

id

readonly id: string

Inherited from

Space.id

Source

packages/framework/store/src/store/space.ts:15

---

rootDoc

readonly rootDoc: BlockSuiteDoc

Inherited from

Space.rootDoc

Source

packages/framework/store/src/store/space.ts:16

---

slots

readonly slots: Object

slots.blockUpdated

blockUpdated: Slot<Object | Object | Object>

slots.historyUpdated

historyUpdated: Slot<void>

slots.ready

ready: Slot<void>

This is always triggered after doc.load is called.

slots.rootAdded

rootAdded: Slot<BlockModel<object>>

This fires when the root block is added via API call or has just been initialized from existing ydoc. useful for internal block UI components to start subscribing following up events. Note that at this moment, the whole block tree may not be fully initialized yet.

slots.rootDeleted

rootDeleted: Slot<string>

Source

packages/framework/store/src/store/doc.ts:47

Accessors

Text

get Text(): typeof Text

Returns

typeof Text

Source

packages/framework/store/src/store/doc.ts:146

---

blob

get blob(): BlobManager

Returns

BlobManager

Source

packages/framework/store/src/store/doc.ts:120

---

canRedo

get canRedo(): boolean

Returns

boolean

Source

packages/framework/store/src/store/doc.ts:139

---

canUndo

get canUndo(): boolean

Returns

boolean

Source

packages/framework/store/src/store/doc.ts:132

---

collection

get collection(): DocCollection

Returns

DocCollection

Source

packages/framework/store/src/store/doc.ts:108

---

history

get history(): UndoManager

Returns

UndoManager

Source

packages/framework/store/src/store/doc.ts:104

---

isEmpty

get isEmpty(): boolean

Returns

boolean

Source

packages/framework/store/src/store/doc.ts:128

---

loaded

get loaded(): boolean

Returns

boolean

Source

packages/framework/store/src/store/space.ts:48

---

meta

get meta(): undefined | DocMeta

Returns

undefined | DocMeta

Source

packages/framework/store/src/store/doc.ts:116

---

readonly

get readonly(): boolean

Returns

boolean

Source

packages/framework/store/src/store/doc.ts:96

---

ready

get ready(): boolean

Returns

boolean

Source

packages/framework/store/src/store/doc.ts:100

---

root

get root(): null | BlockModel<object>

Returns

null | BlockModel<object>

Source

packages/framework/store/src/store/doc.ts:124

---

schema

get schema(): Schema

Returns

Schema

Source

packages/framework/store/src/store/doc.ts:112

---

spaceDoc

get spaceDoc(): Doc

Returns

Doc

Source

packages/framework/store/src/store/space.ts:52

---

yBlocks

get yBlocks(): Map<State[keyof State]>

Returns

Map<State[keyof State]>

Source

packages/framework/store/src/store/space.ts:44

Methods

_getYBlock()

private _getYBlock(id): null | YBlock

Parameters

• id: string

Returns

null | YBlock

Source

packages/framework/store/src/store/doc.ts:702

---

_handleVersion()

private _handleVersion(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:803

---

_handleYBlockAdd()

private _handleYBlockAdd(id): void

Parameters

• id: string

Returns

void

Source

packages/framework/store/src/store/doc.ts:712

---

_handleYBlockDelete()

private _handleYBlockDelete(id): void

Parameters

• id: string

Returns

void

Source

packages/framework/store/src/store/doc.ts:761

---

_handleYEvent()

private _handleYEvent(event): void

Parameters

• event: YEvent<Text | Array<unknown> | YBlock>

Returns

void

Source

packages/framework/store/src/store/doc.ts:778

---

_handleYEvents()

private _handleYEvents(events): void

Parameters

• events: YEvent<Text | YBlock>[]

Returns

void

Source

packages/framework/store/src/store/doc.ts:797

---

_historyObserver()

private _historyObserver(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:708

---

_initYBlocks()

private _initYBlocks(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:689

---

addBlock()

addBlock(flavour, blockProps, parent, parentIndex)

addBlock<Key>(flavour, blockProps?, parent?, parentIndex?): string

Type parameters

• Key extends Flavour

Parameters

• flavour: Key

• blockProps?: Partial<BlockModels[Key] extends BlockModel<U> ? U : never>

• parent?: null | string | BlockModel<object>

• parentIndex?: number

Returns

string

Source

packages/framework/store/src/store/doc.ts:332

addBlock(flavour, blockProps, parent, parentIndex)

addBlock(flavour, blockProps?, parent?, parentIndex?): string

Parameters

• flavour: never

• blockProps?: Partial<BlockSysProps & Object & Omit<BlockProps, "flavour">>

• parent?: null | string | BlockModel<object>

• parentIndex?: number

Returns

string

Source

packages/framework/store/src/store/doc.ts:338

---

addBlocks()

addBlocks(blocks, parent?, parentIndex?): string[]

Parameters

• blocks: Object[]

• parent?: null | string | BlockModel<object>

• parentIndex?: number

Returns

string[]

Source

packages/framework/store/src/store/doc.ts:309

---

addSiblingBlocks()

addSiblingBlocks(targetModel, props, place): string[]

Parameters

• targetModel: BlockModel<object>

• props: Partial<BlockProps>[]

• place: "after" | "before"= 'after'

Returns

string[]

Source

packages/framework/store/src/store/doc.ts:535

---

captureSync()

captureSync(): void

Capture current operations to undo stack synchronously.

Returns

void

Source

packages/framework/store/src/store/doc.ts:180

---

clear()

clear(): void

Returns

void

Inherited from

Space.clear

Source

packages/framework/store/src/store/space.ts:73

---

deleteBlock()

deleteBlock(model, options): void

Parameters

• model: BlockModel<object>

• options= undefined

• options.bringChildrenTo?: BlockModel<object>

• options.deleteChildren?: boolean

Returns

void

Source

packages/framework/store/src/store/doc.ts:572

---

destroy()

destroy(): void

Returns

void

Inherited from

Space.destroy

Source

packages/framework/store/src/store/space.ts:67

---

dispose()

dispose(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:677

---

generateBlockId()

generateBlockId(): string

Returns

string

Source

packages/framework/store/src/store/doc.ts:188

---

getBlockByFlavour()

getBlockByFlavour(blockFlavour): BlockModel<object>[]

Parameters

• blockFlavour: string | string[]

Returns

BlockModel<object>[]

Source

packages/framework/store/src/store/doc.ts:198

---

getBlockById()

getBlockById<Model>(id): null | Model

Type parameters

• Model extends BlockModel<object> = BlockModel<object>

Parameters

• id: string

Returns

null | Model

Source

packages/framework/store/src/store/doc.ts:192

---

getBlocks()

getBlocks(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/framework/store/src/store/doc.ts:298

---

getInitialPropsByFlavour()

getInitialPropsByFlavour(flavour): Record<string, any>

Parameters

• flavour: string

Returns

Record<string, any>

Source

packages/framework/store/src/store/doc.ts:292

---

getNextSibling()

getNextSibling(block): null | BlockModel<object>

Parameters

• block: BlockModel<object>

Returns

null | BlockModel<object>

Source

packages/framework/store/src/store/doc.ts:260

---

getNextSiblings()

getNextSiblings(block): BlockModel<object>[]

Parameters

• block: BlockModel<object>

Returns

BlockModel<object>[]

Source

packages/framework/store/src/store/doc.ts:274

---

getParent()

getParent(target): null | BlockModel<object>

Parameters

• target: string | BlockModel<object>

Returns

null | BlockModel<object>

Source

packages/framework/store/src/store/doc.ts:207

---

getPreviousSibling()

getPreviousSibling(block): null | BlockModel<object>

Parameters

• block: BlockModel<object>

Returns

null | BlockModel<object>

Source

packages/framework/store/src/store/doc.ts:232

---

getPreviousSiblings()

getPreviousSiblings(block): BlockModel<object>[]

Parameters

• block: BlockModel<object>

Returns

BlockModel<object>[]

Source

packages/framework/store/src/store/doc.ts:246

---

getSchemaByFlavour()

getSchemaByFlavour(flavour): undefined | Object

Parameters

• flavour: string

Returns

undefined | Object

Source

packages/framework/store/src/store/doc.ts:288

---

load()

load(initFn?): this

Parameters

• initFn?

Returns

this

Overrides

Space.load

Source

packages/framework/store/src/store/doc.ts:650

---

moveBlocks()

moveBlocks(blocksToMove, newParent, targetSibling, shouldInsertBeforeSibling): void

Parameters

• blocksToMove: BlockModel<object>[]

• newParent: BlockModel<object>

• targetSibling: null | BlockModel<object>= null

• shouldInsertBeforeSibling: boolean= true

Returns

void

Source

packages/framework/store/src/store/doc.ts:395

---

redo()

redo(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:171

---

remove()

remove(): void

Returns

void

Inherited from

Space.remove

Source

packages/framework/store/src/store/space.ts:62

---

resetHistory()

resetHistory(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:184

---

transact()

transact(fn, shouldTransact): void

If shouldTransact is false, the transaction will not be push to the history stack.

Parameters

• fn

• shouldTransact: boolean= undefined

Returns

void

Overrides

Space.transact

Source

packages/framework/store/src/store/doc.ts:156

---

undo()

undo(): void

Returns

void

Source

packages/framework/store/src/store/doc.ts:163

---

updateBlock()

updateBlock(model, props)

updateBlock<T>(model, props): void

Type parameters

• T extends Partial<BlockProps>

Parameters

• model: BlockModel<object>

• props: T

Returns

void

Source

packages/framework/store/src/store/doc.ts:486

updateBlock(model, callback)

updateBlock(model, callback): void

Parameters

• model: BlockModel<object>

• callback

Returns

void

Source

packages/framework/store/src/store/doc.ts:487

---

withoutTransact()

withoutTransact(callback): void

Parameters

• callback

Returns

void

Source

packages/framework/store/src/store/doc.ts:150