Interface IHelpMenu

An interface for a Help menu.

interface IHelpMenu {
    getKernel: SemanticCommand;
    isDisposed: boolean;
    items: readonly IItem[];
    rank?: number;
    addGroup(items, rank?): IDisposable;
    addItem(options): IDisposable;
    dispose(): void;

Hierarchy (view full)

Implemented by


getKernel: SemanticCommand

A semantic command to get the kernel for the help menu. This is used to populate additional help links provided by the kernel of a widget.


The command must return a Kernel.IKernelConnection object

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

items: readonly IItem[]

A read-only array of the menu items in the menu.

rank?: number

Menu rank


  • Add a group of menu items specific to a particular plugin.

    The rank can be set for all items in the group using the function argument or per item.


    • items: IItemOptions[]

      the list of menu items to add.

    • Optional rank: number

      the default rank in the menu in which to insert the group.

    Returns IDisposable

    Disposable of the group

  • Dispose of the resources held by the object.


    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void