UNPKG

1.3 kBTypeScriptView Raw
1import { SemanticCommand } from '@jupyterlab/apputils';
2import { TranslationBundle } from '@jupyterlab/translation';
3import { CommandRegistry } from '@lumino/commands';
4import { JupyterFrontEnd } from './frontend';
5export interface ISemanticCommandDefault {
6 /**
7 * Default command to execute if no command is enabled
8 */
9 execute?: string;
10 /**
11 * Default command label
12 */
13 label?: string;
14 /**
15 * Default command caption
16 */
17 caption?: string;
18 /**
19 * Whether the default command is enabled.
20 */
21 isEnabled?: boolean;
22 /**
23 * Whether the default command is toggled.
24 */
25 isToggled?: boolean;
26 /**
27 * Whether the default command is visible.
28 */
29 isVisible?: boolean;
30}
31/**
32 * Create the command options from the given semantic commands list
33 * and the given default values.
34 *
35 * @param app Jupyter Application
36 * @param semanticCommands Single semantic command or a list of commands
37 * @param defaultValues Default values
38 * @param trans Translation bundle
39 * @returns Command options
40 */
41export declare function createSemanticCommand(app: JupyterFrontEnd, semanticCommands: SemanticCommand | SemanticCommand[], defaultValues: ISemanticCommandDefault, trans: TranslationBundle): CommandRegistry.ICommandOptions;