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

Class: BlockStdScope

Constructors

new BlockStdScope()

new BlockStdScope(options): BlockStdScope

Parameters

• options: BlockStdOptions

Returns

BlockStdScope

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:109

Properties

container

readonly container: Container

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:57

---

doc

readonly doc: Doc

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:59

---

provider

readonly provider: ServiceProvider

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:61

---

userExtensions

readonly userExtensions: ExtensionType[]

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:63

---

internalExtensions

static internalExtensions: ExtensionType[]

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:53

Accessors

clipboard

get clipboard(): Clipboard

Returns

Clipboard

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:69

---

collection

get collection(): DocCollection

Returns

DocCollection

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:73

---

command

get command(): CommandManager

Returns

CommandManager

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:77

---

event

get event(): UIEventDispatcher

Returns

UIEventDispatcher

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:81

---

get

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

Returns

Function

Type Parameters

• T

Parameters

• identifier: GeneralServiceIdentifier<T>

• options?: ResolveOptions

Returns

T

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:85

---

getOptional

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

Returns

Function

Type Parameters

• T

Parameters

• identifier: GeneralServiceIdentifier<T>

• options?: ResolveOptions

Returns

null | T

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:89

---

host

get host(): EditorHost

Returns

EditorHost

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:93

---

range

get range(): RangeManager

Returns

RangeManager

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:97

---

selection

get selection(): SelectionManager

Returns

SelectionManager

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:101

---

view

get view(): ViewStore

Returns

ViewStore

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:105

Methods

getConfig()

getConfig<Key>(flavour): null | BlockConfigs[Key]

Type Parameters

• Key extends never

Parameters

• flavour: Key

Returns

null | BlockConfigs[Key]

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:138

---

getService()

getService(flavour)

getService<Key>(flavour): null | BlockServices[Key]

Type Parameters

• Key extends never

Parameters

• flavour: Key

Returns

null | BlockServices[Key]

Deprecated

BlockService will be removed in the future.

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:155

getService(flavour)

getService<Service>(flavour): null | Service

Type Parameters

• Service extends BlockService

Parameters

• flavour: string

Returns

null | Service

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:158

---

getView()

getView(flavour): null | BlockViewType

Parameters

• flavour: string

Returns

null | BlockViewType

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:163

---

mount()

mount(): void

Returns

void

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:167

---

render()

render(): EditorHost

Returns

EditorHost

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:173

---

unmount()

unmount(): void

Returns

void

Defined in

packages/framework/block-std/src/scope/block-std-scope.ts:185