Skip to content

Vizel API / core/src / VizelSlashMenuFromCommandsOptions

Interface: VizelSlashMenuFromCommandsOptions ​

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

Options accepted by buildVizelSlashMenuSpecFromCommands.

Properties ​

editor ​

ts
readonly editor: Editor;

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

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:57

Custom group display order.


locale ​

ts
readonly locale: VizelLocale;

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

Locale supplying label / description strings.


query ​

ts
readonly query: string;

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

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


selectedIndex ​

ts
readonly selectedIndex: number;

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

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


showGroups? ​

ts
readonly optional showGroups?: boolean;

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

Whether to render groups with headers.

Released under the MIT License.