Options
All
  • Public
  • Public/Protected
  • All
Menu

Module mainmenu-extension

Index

Namespaces

Variables

Functions

Variables

Const default

default: JupyterFrontEndPlugin<IMainMenu> = {id: '@jupyterlab/mainmenu-extension:plugin',requires: [IRouter, ITranslator],optional: [ICommandPalette, ILabShell],provides: IMainMenu,activate: (app: JupyterFrontEnd,router: IRouter,translator: ITranslator,palette: ICommandPalette | null,labShell: ILabShell | null): IMainMenu => {const { commands } = app;const trans = translator.load('jupyterlab');const menu = new MainMenu(commands);menu.id = 'jp-MainMenu';menu.addClass('jp-scrollbar-tiny');// Only add quit button if the back-end supports it by checking page config.const quitButton = PageConfig.getOption('quitButton').toLowerCase();menu.fileMenu.quitEntry = quitButton === 'true';// Create the application menus.createEditMenu(app, menu.editMenu, trans);createFileMenu(app, menu.fileMenu, router, trans);createKernelMenu(app, menu.kernelMenu, trans);createRunMenu(app, menu.runMenu, trans);createSettingsMenu(app, menu.settingsMenu, trans);createViewMenu(app, menu.viewMenu, trans);createHelpMenu(app, menu.helpMenu, trans);// Set the Tabs Title so it's visible also in other shellsconst tabsMenu = menu.tabsMenu;tabsMenu.menu.title.label = trans.__('Tabs');// The tabs menu relies on lab shell functionality.if (labShell) {createTabsMenu(app, tabsMenu, labShell, trans);}// Create commands to open the main application menus.const activateMenu = (item: Menu) => {menu.activeMenu = item;menu.openActiveMenu();};commands.addCommand(CommandIDs.openEdit, {label: trans.__('Open Edit Menu'),execute: () => activateMenu(menu.editMenu.menu)});commands.addCommand(CommandIDs.openFile, {label: trans.__('Open File Menu'),execute: () => activateMenu(menu.fileMenu.menu)});commands.addCommand(CommandIDs.openKernel, {label: trans.__('Open Kernel Menu'),execute: () => activateMenu(menu.kernelMenu.menu)});commands.addCommand(CommandIDs.openRun, {label: trans.__('Open Run Menu'),execute: () => activateMenu(menu.runMenu.menu)});commands.addCommand(CommandIDs.openView, {label: trans.__('Open View Menu'),execute: () => activateMenu(menu.viewMenu.menu)});commands.addCommand(CommandIDs.openSettings, {label: trans.__('Open Settings Menu'),execute: () => activateMenu(menu.settingsMenu.menu)});commands.addCommand(CommandIDs.openTabs, {label: trans.__('Open Tabs Menu'),execute: () => activateMenu(menu.tabsMenu.menu)});commands.addCommand(CommandIDs.openHelp, {label: trans.__('Open Help Menu'),execute: () => activateMenu(menu.helpMenu.menu)});commands.addCommand(CommandIDs.openFirst, {label: trans.__('Open First Menu'),execute: () => {menu.activeIndex = 0;menu.openActiveMenu();}});if (palette) {// Add some of the commands defined here to the command palette.if (menu.fileMenu.quitEntry) {palette.addItem({command: CommandIDs.shutdown,category: trans.__('Main Area')});palette.addItem({command: CommandIDs.logout,category: trans.__('Main Area')});}palette.addItem({command: CommandIDs.shutdownAllKernels,category: trans.__('Kernel Operations')});palette.addItem({command: CommandIDs.activatePreviouslyUsedTab,category: trans.__('Main Area')});}app.shell.add(menu, 'menu', { rank: 100 });return menu;}}

A service providing an interface to the main menu.

Functions

createEditMenu

  • createEditMenu(app: JupyterFrontEnd, menu: EditMenu, trans: TranslationBundle): void

createFileMenu

  • createFileMenu(app: JupyterFrontEnd, menu: FileMenu, router: IRouter, trans: TranslationBundle): void

createHelpMenu

  • createHelpMenu(app: JupyterFrontEnd, menu: HelpMenu, trans: TranslationBundle): void

createKernelMenu

  • createKernelMenu(app: JupyterFrontEnd, menu: KernelMenu, trans: TranslationBundle): void

createRunMenu

  • createRunMenu(app: JupyterFrontEnd, menu: RunMenu, trans: TranslationBundle): void

createSettingsMenu

  • createSettingsMenu(_: JupyterFrontEnd, menu: SettingsMenu, trans: TranslationBundle): void

createTabsMenu

  • createTabsMenu(app: JupyterFrontEnd, menu: TabsMenu, labShell: ILabShell | null, trans: TranslationBundle): void

createViewMenu

  • createViewMenu(app: JupyterFrontEnd, menu: ViewMenu, trans: TranslationBundle): void

Generated using TypeDoc