BlockSuite API Documentation / @blocksuite/blocks / DocModeService

Class: DocModeService

Generic extension. Extensions are used to set up the dependency injection container. In most cases, you won't need to use this class directly. We provide helper classes like CommandExtension and BlockViewExtension to make it easier to create extensions.

Extends

• Extension

Implements

• DocModeProvider

Constructors

new DocModeService()

new DocModeService(std): DocModeService

Parameters

• std: BlockStdScope

Returns

DocModeService

Overrides

Extension.constructor

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:15

Properties

std

std: BlockStdScope

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:14

Methods

getMode()

getMode(id?): DocMode

Parameters

• id?: string

Returns

DocMode

Implementation of

DocModeProvider.getMode

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:17

---

onModeChange()

onModeChange(handler, id?): Disposable

Parameters

• handler

• id?: string

Returns

Disposable

Implementation of

DocModeProvider.onModeChange

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:18

---

setMode()

setMode(mode, id?): void

Parameters

• mode: DocMode

• id?: string

Returns

void

Implementation of

DocModeProvider.setMode

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:19

---

toggleMode()

toggleMode(id?): "edgeless" | "page"

Parameters

• id?: string

Returns

"edgeless" | "page"

Implementation of

DocModeProvider.toggleMode

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:20

---

setup()

static setup(di): void

Parameters

• di: Container

Returns

void

Overrides

Extension.setup

Defined in

packages/affine/shared/dist/services/doc-mode-service.d.ts:16