ISettingsMenu | @jupyterlab (original) (raw)

An interface for a Settings menu.

Hierarchy (View Summary)

• IRankedMenu
  • ISettingsMenu

Implemented by

• SettingsMenu

Index

Properties

ReadonlyisDisposed

isDisposed: boolean

Readonlyitems

items: readonly IItem[]

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

Optional Readonlyrank

rank?: number

Menu rank

Methods

addGroup

• addGroup(items: IItemOptions[], rank?: number): IDisposable

• Parameters

  • items: IItemOptions[]
    the list of menu items to add.
  • Optionalrank: number
    the default rank in the menu in which to insert the group.

Returns IDisposable

Disposable of the group

addItem

• addItem(options: IRankedMenu.IItemOptions): IDisposable
• Add a menu item to the end of the menu.

Returns IDisposable

The disposable menu item added to the menu.

dispose

• dispose(): void

• Returns void