BlockSuite API Documentation / @blocksuite/affine-block-surface / SurfaceBlockService
Class: SurfaceBlockService
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
Constructors
new SurfaceBlockService()
new SurfaceBlockService(
std
,flavourProvider
):SurfaceBlockService
Parameters
• std: BlockStdScope
• flavourProvider
• flavourProvider.flavour: string
Returns
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:28
Properties
disposables
readonly
disposables:DisposableGroup
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:20
flavour
readonly
flavour:string
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:21
flavourProvider
readonly
flavourProvider:object
flavour
flavour:
string
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:16
specSlots
readonly
specSlots:BlockSpecSlots
<BlockService
>
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:22
std
readonly
std:BlockStdScope
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:15
surface
surface:
SurfaceBlockModel
Defined in
packages/affine/block-surface/src/surface-service.ts:9
flavour
readonly
static
flavour:"affine:surface"
=SurfaceBlockSchema.model.flavour
Overrides
Defined in
packages/affine/block-surface/src/surface-service.ts:7
Accessors
collection
get
collection():DocCollection
Returns
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:23
doc
get
doc():Doc
Returns
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:24
host
get
host():EditorHost
Returns
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:25
layer
get
layer():LayerManager
Returns
LayerManager
Defined in
packages/affine/block-surface/src/surface-service.ts:11
selectionManager
get
selectionManager():SelectionManager
Returns
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:26
uiEventDispatcher
get
uiEventDispatcher():UIEventDispatcher
Returns
Inherited from
BlockService
.uiEventDispatcher
Defined in
packages/framework/block-std/dist/extension/service.d.ts:27
Methods
bindHotKey()
bindHotKey(
keymap
,options
?):void
Parameters
• keymap: Record
<string
, UIEventHandler
>
• options?
• options.global?: boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:32
dispose()
dispose():
void
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:35
handleEvent()
handleEvent(
name
,fn
,options
?):void
Parameters
• name: "blur"
| "click"
| "focus"
| "doubleClick"
| "tripleClick"
| "pointerDown"
| "pointerMove"
| "pointerUp"
| "pointerOut"
| "dragStart"
| "dragMove"
| "dragEnd"
| "pinch"
| "pan"
| "keyDown"
| "keyUp"
| "selectionChange"
| "compositionStart"
| "compositionUpdate"
| "compositionEnd"
| "cut"
| "copy"
| "paste"
| "nativeDragStart"
| "nativeDragMove"
| "nativeDragEnd"
| "nativeDrop"
| "beforeInput"
| "contextMenu"
| "wheel"
• fn: UIEventHandler
• options?
• options.global?: boolean
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:36
mounted()
mounted():
void
Returns
void
Overrides
Defined in
packages/affine/block-surface/src/surface-service.ts:15
unmounted()
unmounted():
void
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:40
setup()
static
setup(di
):void
Parameters
• di: Container
Returns
void
Inherited from
Defined in
packages/framework/block-std/dist/extension/service.d.ts:31