BlockSuite API Documentation / @blocksuite/store / StoreSelectionExtension

Class: StoreSelectionExtension

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:12

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

• StoreExtension

Constructors

new StoreSelectionExtension()

new StoreSelectionExtension(store): StoreSelectionExtension

Defined in: packages/framework/store/src/extension/store-extension.ts:16

Parameters

store

Store

Returns

StoreSelectionExtension

Inherited from

StoreExtension.constructor

Properties

slots

slots: object

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:44

changed

changed: Subject<BaseSelection[]>

remoteChanged

remoteChanged: Subject<Map<number, BaseSelection[]>>

---

store

readonly store: Store

Defined in: packages/framework/store/src/extension/store-extension.ts:16

Inherited from

StoreExtension.store

---

[storeExtensionSymbol]

readonly static [storeExtensionSymbol]: true = true

Defined in: packages/framework/store/src/extension/store-extension.ts:24

Inherited from

StoreExtension.[storeExtensionSymbol]

---

key

readonly static key: "selection" = 'selection'

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:13

Overrides

StoreExtension.key

Accessors

remoteSelections

Get Signature

get remoteSelections(): Map<number, BaseSelection[]>

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:114

Returns

Map<number, BaseSelection[]>

---

value

Get Signature

get value(): BaseSelection[]

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:110

Returns

BaseSelection[]

Methods

clear()

clear(types?): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:118

Parameters

types?

string[]

Returns

void

---

create()

create<T>(Type, ...args): InstanceType<T>

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:129

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

Type

T

args

...ConstructorParameters<T>

Returns

InstanceType<T>

---

disposed()

disposed(): void

Defined in: packages/framework/store/src/extension/store-extension.ts:22

Returns

void

Inherited from

StoreExtension.disposed

---

filter()

filter<T>(type): InstanceType<T>[]

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:140

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

type

T

Returns

InstanceType<T>[]

---

filter$()

filter$<T>(type): ReadonlySignal<InstanceType<T>[]>

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:144

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

type

T

Returns

ReadonlySignal<InstanceType<T>[]>

---

find()

find<T>(type): undefined | InstanceType<T>

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:150

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

type

T

Returns

undefined | InstanceType<T>

---

find$()

find$<T>(type): ReadonlySignal<undefined | InstanceType<T>>

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:154

Type Parameters

T

T extends SelectionConstructor<BaseSelection>

Parameters

type

T

Returns

ReadonlySignal<undefined | InstanceType<T>>

---

fromJSON()

fromJSON(json): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:178

Parameters

json

Record<string, unknown>[]

Returns

void

---

getGroup()

getGroup(group): BaseSelection[]

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:136

Parameters

group

string

Returns

BaseSelection[]

---

loaded()

loaded(): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:49

Returns

void

Overrides

StoreExtension.loaded

---

set()

set(selections): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:160

Parameters

selections

BaseSelection[]

Returns

void

---

setGroup()

setGroup(group, selections): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:168

Parameters

group

string

selections

BaseSelection[]

Returns

void

---

update()

update(fn): void

Defined in: packages/framework/store/src/extension/selection/selection-extension.ts:173

Parameters

fn

(currentSelections) => BaseSelection[]

Returns

void

---

setup()

static setup(di): void

Defined in: packages/framework/store/src/extension/store-extension.ts:26

Parameters

di

Container

Returns

void

Inherited from

StoreExtension.setup