Skip to content

Vizel API / core/src / VizelSlashMenuFromCommandsOptions

Interface: VizelSlashMenuFromCommandsOptions

Defined in: packages/core/src/builders/slash-menu.ts:44

Options accepted by buildVizelSlashMenuSpecFromCommands.

Properties

editor

ts
readonly editor: Editor;

Defined in: packages/core/src/builders/slash-menu.ts:46

Editor instance the commands run against (used for canRun/isActive).


groupOrder?

ts
readonly optional groupOrder?: readonly string[];

Defined in: packages/core/src/builders/slash-menu.ts:56

Custom group display order.


locale

ts
readonly locale: VizelLocale;

Defined in: packages/core/src/builders/slash-menu.ts:48

Locale supplying label / description strings.


query

ts
readonly query: string;

Defined in: packages/core/src/builders/slash-menu.ts:50

Current query string; commands are filtered by name + keywords.


selectedIndex

ts
readonly selectedIndex: number;

Defined in: packages/core/src/builders/slash-menu.ts:52

Index of the keyboard-active selection (zero-based).


showGroups?

ts
readonly optional showGroups?: boolean;

Defined in: packages/core/src/builders/slash-menu.ts:54

Whether to render groups with headers.

Released under the MIT License.