@jupyterlab/apputils/lib/semanticCommand.d.ts

JupyterLab - Application Utilities

import { Widget } from '@lumino/widgets';
/**
 * Options when add a command to a semantic group.
 */
interface ISemanticCommand {
    /**
     * Command id
     */
    id: string;
    /**
     * Whether this command is enabled for a given widget
     * @param widget Widget
     */
    isEnabled?(widget: Widget): boolean;
    /**
     * Command rank in the semantic group
     *
     * #### Note
     * If multiple commands are enabled at the same time,
     * the one with the smallest rank will be executed.
     */
    rank?: number;
}
/**
 * Semantic group of commands
 */
export declare class SemanticCommand {
    /**
     * Default rank for semantic command
     */
    static readonly DEFAULT_RANK = 500;
    /**
     * The `args` key for a semantic command's current widget ID.
     */
    static readonly WIDGET = "semanticWidget";
    /**
     * The command IDs used by this semantic command.
     */
    get ids(): string[];
    /**
     * Add a command to the semantic group
     *
     * @param command Command to add
     */
    add(command: ISemanticCommand): void;
    /**
     * Get the command id of the enabled command from this group
     * for the given widget.
     *
     * @param widget Widget
     * @returns Command id
     */
    getActiveCommandId(widget: Widget): string | null;
    /**
     * Remove a command ID.
     *
     * @param id Command ID to remove
     */
    remove(id: string): void;
    protected _commands: Required<ISemanticCommand>[];
}
export {};