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

Class: BlockStdScope

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:51

Constructors

new BlockStdScope()

new BlockStdScope(options): BlockStdScope

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:119

Parameters

options

BlockStdOptions

Returns

BlockStdScope

Properties

container

readonly container: Container

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

---

provider

readonly provider: ServiceProvider

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:58

---

store

readonly store: Store

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:56

---

userExtensions

readonly userExtensions: ExtensionType[]

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

---

internalExtensions

static internalExtensions: (typeof Clipboard | typeof RangeManager | typeof ViewStore | typeof CommandManager | typeof UIEventDispatcher | typeof LayerManager | typeof GfxSelectionManager | typeof SurfaceMiddlewareExtension | typeof ViewManager | typeof GridManager | typeof ServiceManager)[]

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

Accessors

clipboard

Get Signature

get clipboard(): Clipboard

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:72

Returns

Clipboard

---

command

Get Signature

get command(): CommandManager

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:80

Returns

CommandManager

---

dnd

Get Signature

get dnd(): DndController

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:68

Returns

DndController

---

event

Get Signature

get event(): UIEventDispatcher

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:84

Returns

UIEventDispatcher

---

get

Get Signature

get get(): <T>(identifier, options?) => T

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:88

Returns

Function

Type Parameters

T

T

Parameters

identifier

GeneralServiceIdentifier<T>

options?

ResolveOptions

Returns

T

---

getOptional

Get Signature

get getOptional(): <T>(identifier, options?) => null | T

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:92

Returns

Function

Type Parameters

T

T

Parameters

identifier

GeneralServiceIdentifier<T>

options?

ResolveOptions

Returns

null | T

---

host

Get Signature

get host(): EditorHost

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:96

Returns

EditorHost

---

range

Get Signature

get range(): RangeManager

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:107

Returns

RangeManager

---

selection

Get Signature

get selection(): StoreSelectionExtension

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

Returns

StoreSelectionExtension

---

view

Get Signature

get view(): ViewStore

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

Returns

ViewStore

---

workspace

Get Signature

get workspace(): Workspace

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:76

Returns

Workspace

Methods

getView()

getView(flavour): null | BlockViewType

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:142

Parameters

flavour

string

Returns

null | BlockViewType

---

mount()

mount(): void

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:146

Returns

void

---

render()

render(): EditorHost

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:152

Returns

EditorHost

---

unmount()

unmount(): void

Defined in: packages/framework/block-std/src/scope/block-std-scope.ts:164

Returns

void