BlockSuite API Documentation / @blocksuite/affine-block-root / PageRootService

Class: PageRootService

Defined in: packages/affine/blocks/block-root/src/page/page-root-service.ts:5

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

• RootService

Constructors

new PageRootService()

new PageRootService(std, flavourProvider): PageRootService

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

Parameters

std

BlockStdScope

flavourProvider

flavour

string

Returns

PageRootService

Inherited from

RootService.constructor

Properties

disposables

readonly disposables: DisposableGroup

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

Inherited from

RootService.disposables

---

flavour

readonly flavour: string

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

Inherited from

RootService.flavour

---

flavourProvider

readonly flavourProvider: object

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

flavour

flavour: string

Inherited from

RootService.flavourProvider

---

specSlots

readonly specSlots: BlockSpecSlots<BlockService>

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

Inherited from

RootService.specSlots

---

std

readonly std: BlockStdScope

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

Inherited from

RootService.std

---

flavour

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

Defined in: packages/affine/blocks/block-root/src/page/page-root-service.ts:6

Overrides

RootService.flavour

Accessors

collection

Get Signature

get collection(): Workspace

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

Returns

Workspace

Inherited from

RootService.collection

---

doc

Get Signature

get doc(): Store

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

Returns

Store

Inherited from

RootService.doc

---

host

Get Signature

get host(): EditorHost

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

Returns

EditorHost

Inherited from

RootService.host

---

selectedBlocks

Get Signature

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

Defined in: packages/affine/blocks/block-root/src/root-service.ts:16

Returns

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

Inherited from

RootService.selectedBlocks

---

selectedModels

Get Signature

get selectedModels(): BlockModel<object>[]

Defined in: packages/affine/blocks/block-root/src/root-service.ts:34

Returns

BlockModel<object>[]

Inherited from

RootService.selectedModels

---

selectionManager

Get Signature

get selectionManager(): StoreSelectionExtension

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

Returns

StoreSelectionExtension

Inherited from

RootService.selectionManager

---

uiEventDispatcher

Get Signature

get uiEventDispatcher(): UIEventDispatcher

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

Returns

UIEventDispatcher

Inherited from

RootService.uiEventDispatcher

---

viewportElement

Get Signature

get viewportElement(): null | HTMLElement

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

Returns

null | HTMLElement

Inherited from

RootService.viewportElement

Methods

bindHotKey()

bindHotKey(keymap, options?): void

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

Parameters

keymap

Record<string, UIEventHandler>

options?

global

boolean

Returns

void

Inherited from

RootService.bindHotKey

---

dispose()

dispose(): void

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

Returns

void

Inherited from

RootService.dispose

---

handleEvent()

handleEvent(name, fn, options?): void

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

Parameters

name

"click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "pinch" | "pan" | "keyDown" | "keyUp" | "selectionChange" | "compositionStart" | "compositionUpdate" | "compositionEnd" | "cut" | "copy" | "paste" | "nativeDragStart" | "nativeDragMove" | "nativeDragEnd" | "nativeDrop" | "nativeDragOver" | "nativeDragLeave" | "beforeInput" | "blur" | "focus" | "contextMenu" | "wheel"

fn

UIEventHandler

options?

global

boolean

Returns

void

Inherited from

RootService.handleEvent

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:39

Returns

void

Inherited from

RootService.mounted

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/dist/extension/service.d.ts:40

Returns

void

Inherited from

RootService.unmounted

---

setup()

static setup(di): void

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

Parameters

di

Container

Returns

void

Inherited from

RootService.setup