Interface ICommandPalette

The interface for a Jupyter Lab command palette.

interface ICommandPalette {
    placeholder: string;
    activate(): void;
    addItem(options): IDisposable;
}

Index

Properties

Methods

activate addItem

Properties

placeholder

placeholder: string

The placeholder text of the command palette's search input.

Methods

activate

activate(): void
Activate the command palette for user input.

Returns void
- Defined in packages/apputils/src/tokens.ts:39

addItem

addItem(options): IDisposable
Add a command item to the command palette.
Parameters
- options: IPaletteItem
  The options for creating the command item.
Returns IDisposable
A disposable that will remove the item from the palette.
- Defined in packages/apputils/src/tokens.ts:48