BlockSuite API Documentation / @blocksuite/affine-gfx-group

@blocksuite/affine-gfx-group

Classes

GroupElementView

The methods that a graphic element should implement. It is already included in the GfxCompatibleInterface interface.

Extends

• GfxElementModelView<GroupElementModel>

Constructors

Properties

type

static type: string = 'group'

Overrides

GfxElementModelView.type

Accessors

Methods

onCreated()

onCreated(): void

Returns

void

Overrides

GfxElementModelView.onCreated

Variables

createGroupCommand

const createGroupCommand: Command<{ elements: GfxModel[] | string[]; }, { groupId: string; }>

---

createGroupFromSelectedCommand

const createGroupFromSelectedCommand: Command<{ }, { groupId: string; }>

---

group

const group: ElementRenderer<GroupElementModel>

---

GroupDomRendererExtension

const GroupDomRendererExtension: ExtensionType

---

GroupElementRendererExtension

const GroupElementRendererExtension: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<ElementRenderer<GroupElementModel>>

---

GroupInteraction

const GroupInteraction: ExtensionType

---

groupToMarkdownAdapterMatcher

const groupToMarkdownAdapterMatcher: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<ElementToMarkdownAdapterMatcher>

---

groupToolbarConfig

const groupToolbarConfig: object

Type Declaration

actions

readonly actions: [{ icon: TemplateResult<1>; id: "a.insert-into-page"; label: "Insert into Page"; tooltip: "Insert into Page"; when: (ctx) => boolean; run: void; }, { icon: TemplateResult<1>; id: "b.rename"; tooltip: "Rename"; when: (ctx) => boolean; run: void; }, { icon: TemplateResult<1>; id: "b.ungroup"; tooltip: "Ungroup"; run: void; }]

when()

readonly when: (ctx) => boolean

Parameters

ctx

ToolbarContext

Returns

boolean

---

groupToolbarExtension

const groupToolbarExtension: ExtensionType

---

groupToPlainTextAdapterMatcher

const groupToPlainTextAdapterMatcher: ExtensionType & object

Type Declaration

identifier

identifier: ServiceIdentifier<ElementToPlainTextAdapterMatcher>

---

ungroupCommand

const ungroupCommand: Command<{ group: GroupElementModel; }, { }>

Functions

mountGroupTitleEditor()

mountGroupTitleEditor(group, edgeless): void

Parameters

group

GroupElementModel

edgeless

BlockComponent

Returns

void