BlockSuite API Documentation / @blocksuite/blocks / RootService

Class: abstract RootService

Deprecated

BlockService is deprecated. You should reconsider where to put your feature.

BlockService is a legacy extension that is used to provide services to the block. In the previous version of BlockSuite, block service provides a way to extend the block. However, in the new version, we recommend using the new extension system.

Extends

• BlockService

Extended by

• PageRootService
• EdgelessRootService

Constructors

new RootService()

new RootService(std, flavourProvider): RootService

Parameters

• std: BlockStdScope

• flavourProvider

• flavourProvider.flavour: string

Returns

RootService

Inherited from

BlockService.constructor

Defined in

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

Properties

disposables

readonly disposables: DisposableGroup

Inherited from

BlockService.disposables

Defined in

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

---

editPropsStore

readonly editPropsStore: EditPropsStore

Defined in

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

---

exportManager

readonly exportManager: ExportManager

Defined in

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

---

fileDropManager

readonly fileDropManager: FileDropManager

Defined in

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

---

flavour

readonly flavour: string

Inherited from

BlockService.flavour

Defined in

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

---

flavourProvider

readonly flavourProvider: object

flavour

flavour: string

Inherited from

BlockService.flavourProvider

Defined in

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

---

notificationService

notificationService: null | NotificationService = null

Defined in

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

---

peekViewService

peekViewService: null | PeekViewService = null

Defined in

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

---

slots

abstract slots: RefNodeSlots

Defined in

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

---

specSlots

readonly specSlots: BlockSpecSlots<BlockService>

Inherited from

BlockService.specSlots

Defined in

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

---

std

readonly std: BlockStdScope

Inherited from

BlockService.std

Defined in

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

---

themeObserver

readonly themeObserver: ThemeObserver = ThemeObserver.instance

Defined in

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

---

transformers

transformers: object

html

html: object = HtmlTransformer

html.exportDoc()

html.exportDoc: (doc) => Promise<void>

Parameters

• doc: Doc

Returns

Promise<void>

markdown

markdown: object = MarkdownTransformer

markdown.exportDoc()

markdown.exportDoc: (doc) => Promise<void>

Parameters

• doc: Doc

Returns

Promise<void>

markdown.importMarkdown()

markdown.importMarkdown: (__namedParameters) => Promise<void>

Parameters

• __namedParameters: ImportMarkdownOptions

Returns

Promise<void>

zip

zip: object = ZipTransformer

zip.exportDocs()

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

Parameters

• collection: DocCollection

• docs: Doc[]

Returns

Promise<Blob>

zip.importDocs()

zip.importDocs: (collection, imported) => Promise<(undefined | Doc)[]>

Parameters

• collection: DocCollection

• imported: Blob

Returns

Promise<(undefined | Doc)[]>

Defined in

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

---

flavour

readonly static flavour: "affine:page" = RootBlockSchema.model.flavour

Overrides

BlockService.flavour

Defined in

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

Accessors

collection

get collection(): DocCollection

Returns

DocCollection

Inherited from

BlockService.collection

Defined in

packages/framework/block-std/dist/extension/service.d.ts:23

---

doc

get doc(): Doc

Returns

Doc

Inherited from

BlockService.doc

Defined in

packages/framework/block-std/dist/extension/service.d.ts:24

---

host

get host(): EditorHost

Returns

EditorHost

Inherited from

BlockService.host

Defined in

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

---

selectedBlocks

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

Returns

BlockComponent<BlockModel<object, SignaledProps<object>>, BlockService, string>[]

Defined in

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

---

selectedModels

get selectedModels(): BlockModel<object, SignaledProps<object>>[]

Returns

BlockModel<object, SignaledProps<object>>[]

Defined in

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

---

selectionManager

get selectionManager(): SelectionManager

Returns

SelectionManager

Inherited from

BlockService.selectionManager

Defined in

packages/framework/block-std/dist/extension/service.d.ts:26

---

uiEventDispatcher

get uiEventDispatcher(): UIEventDispatcher

Returns

UIEventDispatcher

Inherited from

BlockService.uiEventDispatcher

Defined in

packages/framework/block-std/dist/extension/service.d.ts:27

---

viewportElement

get viewportElement(): null | HTMLElement

Returns

null | HTMLElement

Defined in

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

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Parameters

• keymap: Record<string, UIEventHandler>

• options?

• options.global?: boolean

Returns

void

Inherited from

BlockService.bindHotKey

Defined in

packages/framework/block-std/dist/extension/service.d.ts:32

---

dispose()

dispose(): void

Returns

void

Inherited from

BlockService.dispose

Defined in

packages/framework/block-std/dist/extension/service.d.ts:35

---

handleEvent()

handleEvent(name, fn, options?): void

Parameters

• name: "pan" | "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "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

Defined in

packages/framework/block-std/dist/extension/service.d.ts:36

---

mounted()

mounted(): void

Returns

void

Overrides

BlockService.mounted

Defined in

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

---

unmounted()

unmounted(): void

Returns

void

Overrides

BlockService.unmounted

Defined in

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

---

setup()

static setup(di): void

Parameters

• di: Container

Returns

void

Inherited from

BlockService.setup

Defined in

packages/framework/block-std/dist/extension/service.d.ts:31