BlockSuite API Documentation / @blocksuite/affine-block-surface / EdgelessCRUDExtension

Class: EdgelessCRUDExtension

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:21

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

• Extension

Constructors

new EdgelessCRUDExtension()

new EdgelessCRUDExtension(std): EdgelessCRUDExtension

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:22

Parameters

std

BlockStdScope

Returns

EdgelessCRUDExtension

Overrides

Extension.constructor

Properties

std

readonly std: BlockStdScope

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:22

Methods

addBlock()

addBlock(flavour, props, parentId?, parentIndex?): string

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:67

Parameters

flavour

string

props

Record<string, unknown>

parentId?

string | BlockModel<object>

parentIndex?

number

Returns

string

---

addElement()

addElement<T>(type, props): undefined | string

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:92

Type Parameters

T

T extends Record<string, unknown>

Parameters

type

string

props

T

Returns

undefined | string

---

deleteElements()

deleteElements(elements): void

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:39

Parameters

elements

GfxModel[]

Returns

void

---

getElementById()

getElementById(id): null | GfxModel

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:143

Parameters

id

string

Returns

null | GfxModel

---

getElementsByType()

getElementsByType<K>(type): SurfaceElementModelMap[K][]

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:152

Type Parameters

K

K extends keyof SurfaceElementModelMap

Parameters

type

K

Returns

SurfaceElementModelMap[K][]

---

removeElement()

removeElement(id): void

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:161

Parameters

id

string | GfxModel

Returns

void

---

updateElement()

updateElement(id, props): void

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:114

Parameters

id

string

props

Record<string, unknown>

Returns

void

---

setup()

static setup(di): void

Defined in: packages/affine/blocks/block-surface/src/extensions/crud-extension.ts:26

Parameters

di

Container

Returns

void

Overrides

Extension.setup