UNPKG

1.6 kBTypeScriptView Raw
1import { Message } from '@lumino/messaging';
2import { CommandPalette, Panel } from '@lumino/widgets';
3/**
4 * Wrap the command palette in a modal to make it more usable.
5 */
6export declare class ModalCommandPalette extends Panel {
7 constructor(options: ModalCommandPalette.IOptions);
8 get palette(): CommandPalette;
9 set palette(value: CommandPalette);
10 attach(): void;
11 detach(): void;
12 /**
13 * Hide the modal command palette and reset its search.
14 */
15 hideAndReset(): void;
16 /**
17 * Handle incoming events.
18 */
19 handleEvent(event: Event): void;
20 /**
21 * Find the element with search icon group.
22 */
23 protected get searchIconGroup(): HTMLDivElement | undefined;
24 /**
25 * Create element with search icon group.
26 */
27 protected createSearchIconGroup(): HTMLDivElement;
28 /**
29 * A message handler invoked on an `'after-attach'` message.
30 */
31 protected onAfterAttach(msg: Message): void;
32 /**
33 * A message handler invoked on an `'after-detach'` message.
34 */
35 protected onAfterDetach(msg: Message): void;
36 protected onBeforeHide(msg: Message): void;
37 protected onAfterShow(msg: Message): void;
38 /**
39 * A message handler invoked on an `'activate-request'` message.
40 */
41 protected onActivateRequest(msg: Message): void;
42 /**
43 * Handle the `'keydown'` event for the widget.
44 */
45 protected _evtKeydown(event: KeyboardEvent): void;
46 private _commandPalette;
47}
48export declare namespace ModalCommandPalette {
49 interface IOptions {
50 commandPalette: CommandPalette;
51 }
52}