Skip to content

Vizel API / core/src / VizelBlockMenuAction

Interface: VizelBlockMenuAction

Defined in: packages/core/src/extensions/block-menu.ts:11

A single block menu action definition.

Properties

group

ts
group: string;

Defined in: packages/core/src/extensions/block-menu.ts:19

Group identifier for visual separation


icon

ts
icon: VizelBlockMenuIconName;

Defined in: packages/core/src/extensions/block-menu.ts:17

Icon name from the Vizel icon system


id

ts
id: string;

Defined in: packages/core/src/extensions/block-menu.ts:13

Unique action identifier


isEnabled?

ts
optional isEnabled?: (editor, node) => boolean;

Defined in: packages/core/src/extensions/block-menu.ts:23

Check if this action can be executed on the given node

Parameters

ParameterType
editorEditor
nodeNode

Returns

boolean


label

ts
label: string;

Defined in: packages/core/src/extensions/block-menu.ts:15

Display label


run

ts
run: (editor, pos, node) => void;

Defined in: packages/core/src/extensions/block-menu.ts:21

Execute the action

Parameters

ParameterType
editorEditor
posnumber
nodeNode

Returns

void


shortcut?

ts
optional shortcut?: string;

Defined in: packages/core/src/extensions/block-menu.ts:25

Optional keyboard shortcut label for tooltip

Released under the MIT License.