BlockSuite API Documentation / @blocksuite/blocks / RootService

Class: RootService

Extends

• BlockService<RootBlockModel>

Constructors

new RootService(options)

new RootService(options): RootService

Parameters

• options: BlockServiceOptions

Returns

RootService

Inherited from

BlockService.constructor

Source

packages/framework/block-std/dist/service/index.d.ts:16

Properties

_embedBlockRegistry

private _embedBlockRegistry: Set<EmbedOptions>

Source

packages/blocks/src/root-block/root-service.ts:103

---

_exportOptions

private _exportOptions: object

imageProxyEndpoint

imageProxyEndpoint: string = DEFAULT_IMAGE_PROXY_ENDPOINT

Source

packages/blocks/src/root-block/root-service.ts:68

---

_fileDropOptions

private _fileDropOptions: FileDropOptions

Source

packages/blocks/src/root-block/root-service.ts:64

---

_getDocUpdatedAt()

private _getDocUpdatedAt: (docId) => Date

Parameters

• docId: string

Returns

Date

Source

packages/blocks/src/root-block/root-service.ts:93

---

_getEditorMode()

private _getEditorMode: (docId) => "page" | "edgeless"

Parameters

• docId: string

Returns

"page" | "edgeless"

Source

packages/blocks/src/root-block/root-service.ts:82

---

copilot

readonly copilot: Copilot

Source

packages/blocks/src/root-block/root-service.ts:53

---

disposables

readonly disposables: DisposableGroup

Inherited from

BlockService.disposables

Source

packages/framework/block-std/dist/service/index.d.ts:14

---

editSession

readonly editSession: EditSessionStorage

Source

packages/blocks/src/root-block/root-service.ts:52

---

exportManager

exportManager: ExportManager

Source

packages/blocks/src/root-block/root-service.ts:56

---

fileDropManager

fileDropManager: FileDropManager

Source

packages/blocks/src/root-block/root-service.ts:55

---

flavour

readonly flavour: string

Inherited from

BlockService.flavour

Source

packages/framework/block-std/dist/service/index.d.ts:13

---

fontLoader

readonly fontLoader: FontLoader

Source

packages/blocks/src/root-block/root-service.ts:51

---

specSlots

readonly specSlots: BlockSpecSlots

Inherited from

BlockService.specSlots

Source

packages/framework/block-std/dist/service/index.d.ts:15

---

std

readonly std: BlockStdScope

Inherited from

BlockService.std

Source

packages/framework/block-std/dist/service/index.d.ts:12

---

transformers

transformers: object

html

html: object = HtmlTransformer

html.exportDoc()

exportDoc: (doc) => Promise<void>

Parameters

• doc: Doc

Returns

Promise<void>

markdown

markdown: object = MarkdownTransformer

markdown.exportDoc()

exportDoc: (doc) => Promise<void>

Parameters

• doc: Doc

Returns

Promise<void>

markdown.importMarkdown()

importMarkdown: (__namedParameters) => Promise<void>

Parameters

• __namedParameters: ImportMarkdownOptions

Returns

Promise<void>

zip

zip: object = ZipTransformer

zip.exportDocs()

exportDocs: (collection, docs) => Promise<Blob>

Parameters

• collection: DocCollection

• docs: Doc[]

Returns

Promise<Blob>

zip.importDocs()

importDocs: (collection, imported) => Promise<Doc[]>

Parameters

• collection: DocCollection

• imported: Blob

Returns

Promise<Doc[]>

Source

packages/blocks/src/root-block/root-service.ts:58

Accessors

collection

get collection(): DocCollection

Returns

DocCollection

Source

packages/framework/block-std/dist/service/index.d.ts:17

---

doc

get doc(): Doc

Returns

Doc

Source

packages/framework/block-std/dist/service/index.d.ts:18

---

getDocUpdatedAt

get getDocUpdatedAt(): (docId) => Date

set getDocUpdatedAt(value): void

Parameters

• value

Returns

Function

Parameters

• docId: string

Returns

Date

Source

packages/blocks/src/root-block/root-service.ts:95

---

getEditorMode

get getEditorMode(): (docId) => "page" | "edgeless"

set getEditorMode(value): void

Parameters

• value

Returns

Function

Parameters

• docId: string

Returns

"page" | "edgeless"

Source

packages/blocks/src/root-block/root-service.ts:85

---

host

get host(): HTMLElement

Returns

HTMLElement

Source

packages/framework/block-std/dist/service/index.d.ts:19

---

selectedBlocks

get selectedBlocks(): BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Returns

BlockElement<BlockModel<object>, BlockService<BlockModel<object>>, string>[]

Source

packages/blocks/src/root-block/root-service.ts:166

---

selectedModels

get selectedModels(): BlockModel<object>[]

Returns

BlockModel<object>[]

Source

packages/blocks/src/root-block/root-service.ts:184

---

selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Source

packages/framework/block-std/dist/service/index.d.ts:20

---

uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Source

packages/framework/block-std/dist/service/index.d.ts:21

---

viewportElement

get viewportElement(): HTMLElement

Returns

HTMLElement

Source

packages/blocks/src/root-block/root-service.ts:72

Methods

_getLastNoteBlock()

private _getLastNoteBlock(): null | NoteBlockModel

Returns

null | NoteBlockModel

Source

packages/blocks/src/root-block/root-service.ts:192

---

appendParagraph()

appendParagraph(text): void

Parameters

• text: string= ''

Returns

void

Source

packages/blocks/src/root-block/root-service.ts:210

---

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?

• options.global?: boolean

Returns

void

Inherited from

BlockService.bindHotKey

Source

packages/framework/block-std/dist/service/index.d.ts:28

---

dispose()

dispose(): void

Returns

void

Inherited from

BlockService.dispose

Source

packages/framework/block-std/dist/service/index.d.ts:22

---

getEmbedBlockOptions()

getEmbedBlockOptions(url): null | EmbedOptions

Parameters

• url: string

Returns

null | EmbedOptions

Source

packages/blocks/src/root-block/root-service.ts:109

---

handleEvent()

handleEvent(name, fn, options?): void

Parameters

• name: "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "beforeInput" | "blur" | "focus" | "drop" | "contextMenu" | "wheel"

• fn: UIEventHandler

• options?

• options.global?: boolean

Returns

void

Inherited from

BlockService.handleEvent

Source

packages/framework/block-std/dist/service/index.d.ts:25

---

loadFonts()

loadFonts(): void

Returns

void

Source

packages/blocks/src/root-block/root-service.ts:188

---

mounted()

mounted(): void

Returns

void

Overrides

BlockService.mounted

Source

packages/blocks/src/root-block/root-service.ts:122

---

registerEmbedBlockOptions()

registerEmbedBlockOptions(options): void

Parameters

• options: EmbedOptions

Returns

void

Source

packages/blocks/src/root-block/root-service.ts:105

---

unmounted()

unmounted(): void

Returns

void

Overrides

BlockService.unmounted

Source

packages/blocks/src/root-block/root-service.ts:118