Theia API Documentation v1.66.0
    Preparing search index...

    Interface IItem

    An object which represents an item in a command palette.

    Item objects are created automatically by a command palette.

    interface IItem {
        args: ReadonlyJSONObject;
        caption: string;
        category: string;
        className: string;
        command: string;
        dataset: Dataset;
        icon: undefined | IRenderer;
        iconClass: string;
        iconLabel: string;
        isEnabled: boolean;
        isToggleable: boolean;
        isToggled: boolean;
        isVisible: boolean;
        keyBinding: null | IKeyBinding;
        label: string;
        rank: number;
    }
    Index

    Properties

    args caption category className command dataset icon iconClass iconLabel isEnabled isToggleable isToggled isVisible keyBinding label rank

    Properties

    args: ReadonlyJSONObject

    The arguments for the command.

    caption: string

    The display caption for the command item.

    category: string

    The category for the command item.

    className: string

    The extra class name for the command item.

    command: string

    The command to execute when the item is triggered.

    dataset: Dataset

    The dataset for the command item.

    icon: undefined | IRenderer

    The icon renderer for the command item.

    iconClass: string

    The icon class for the command item.

    iconLabel: string

    The icon label for the command item.

    isEnabled: boolean

    Whether the command item is enabled.

    isToggleable: boolean

    Whether the command item is toggleable.

    isToggled: boolean

    Whether the command item is toggled.

    isVisible: boolean

    Whether the command item is visible.

    keyBinding: null | IKeyBinding

    The key binding for the command item.

    label: string

    The display label for the command item.

    rank: number

    The rank for the command item.

    Settings

    Member Visibility

    On This Page

    Notes
    Properties