BlockSuite API Documentation / @blocksuite/block-std / BlockService

Class: abstract BlockService

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

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

• Extension

Extended by

• EmbedGithubBlockService
• EmbedLoomBlockService
• EmbedYoutubeBlockService
• ImageBlockService
• NoteBlockService
• ParagraphBlockService
• RootService
• SurfaceBlockService

Constructors

new BlockService()

new BlockService(std, flavourProvider): BlockService

Defined in: packages/framework/block-std/src/extension/service.ts:52

Parameters

std

BlockStdScope

flavourProvider

flavour

string

Returns

BlockService

Overrides

Extension.constructor

Properties

disposables

readonly disposables: DisposableGroup

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

---

flavour

readonly flavour: string

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

---

flavourProvider

readonly flavourProvider: object

Defined in: packages/framework/block-std/src/extension/service.ts:54

flavour

flavour: string

---

specSlots

readonly specSlots: BlockSpecSlots<BlockService>

Defined in: packages/framework/block-std/src/extension/service.ts:30

---

std

readonly std: BlockStdScope

Defined in: packages/framework/block-std/src/extension/service.ts:53

---

flavour

static flavour: string

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

Accessors

collection

Get Signature

get collection(): Workspace

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

Returns

Workspace

---

doc

Get Signature

get doc(): Store

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

Returns

Store

---

host

Get Signature

get host(): EditorHost

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

Returns

EditorHost

---

selectionManager

Get Signature

get selectionManager(): StoreSelectionExtension

Defined in: packages/framework/block-std/src/extension/service.ts:44

Returns

StoreSelectionExtension

---

uiEventDispatcher

Get Signature

get uiEventDispatcher(): UIEventDispatcher

Defined in: packages/framework/block-std/src/extension/service.ts:48

Returns

UIEventDispatcher

Methods

bindHotKey()

bindHotKey(keymap, options?): void

Defined in: packages/framework/block-std/src/extension/service.ts:81

Parameters

keymap

Record<string, UIEventHandler>

options?

global

boolean

Returns

void

---

dispose()

dispose(): void

Defined in: packages/framework/block-std/src/extension/service.ts:93

Returns

void

---

handleEvent()

handleEvent(name, fn, options?): void

Defined in: packages/framework/block-std/src/extension/service.ts:98

Parameters

name

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

fn

UIEventHandler

options?

global

boolean

Returns

void

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/src/extension/service.ts:111

Returns

void

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/src/extension/service.ts:115

Returns

void

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/src/extension/service.ts:60

Parameters

di

Container

Returns

void

Overrides

Extension.setup