UNPKG

1.05 kBTypeScriptView Raw
1import { IRankedMenu, RankedMenu } from '@jupyterlab/ui-components';
2import { SemanticCommand } from '@jupyterlab/apputils';
3/**
4 * An interface for a Help menu.
5 */
6export interface IHelpMenu extends IRankedMenu {
7 /**
8 * A semantic command to get the kernel for the help menu.
9 * This is used to populate additional help
10 * links provided by the kernel of a widget.
11 *
12 * #### Note
13 * The command must return a Kernel.IKernelConnection object
14 */
15 readonly getKernel: SemanticCommand;
16}
17/**
18 * An extensible Help menu for the application.
19 */
20export declare class HelpMenu extends RankedMenu implements IHelpMenu {
21 /**
22 * Construct the help menu.
23 */
24 constructor(options: IRankedMenu.IOptions);
25 /**
26 * A semantic command to get the kernel for the help menu.
27 * This is used to populate additional help
28 * links provided by the kernel of a widget.
29 *
30 * #### Note
31 * The command must return a Kernel.IKernelConnection object
32 */
33 readonly getKernel: SemanticCommand;
34}