Merge pull request #6678 from ivanov/move-contextual-help

move contextual help to the help menu
jupyterlab · Jun 21, 2019 · f4829a7 · f4829a7
2 parents 2618a9a + e9dbacc
commit f4829a7
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 20 deletions.
diff --git a/packages/help-extension/package.json b/packages/help-extension/package.json
@@ -39,6 +39,7 @@
     "@jupyterlab/application": "^1.0.0-alpha.13",
     "@jupyterlab/apputils": "^1.0.0-alpha.13",
     "@jupyterlab/coreutils": "^3.0.0-alpha.13",
+    "@jupyterlab/inspector": "^1.0.0-alpha.13",
     "@jupyterlab/mainmenu": "^1.0.0-alpha.13",
     "@jupyterlab/services": "^4.0.0-alpha.13",
     "@phosphor/widgets": "^1.8.0",

diff --git a/packages/help-extension/src/index.tsx b/packages/help-extension/src/index.tsx
@@ -18,6 +18,8 @@ import {
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 
+import { IInspector } from '@jupyterlab/inspector';
+
 import { IMainMenu } from '@jupyterlab/mainmenu';
 
 import { KernelMessage } from '@jupyterlab/services';
@@ -89,7 +91,7 @@ const plugin: JupyterFrontEndPlugin<void> = {
   activate,
   id: '@jupyterlab/help-extension:plugin',
   requires: [IMainMenu],
-  optional: [ICommandPalette, ILayoutRestorer],
+  optional: [ICommandPalette, ILayoutRestorer, IInspector],
   autoStart: true
 };
 
@@ -109,7 +111,8 @@ function activate(
   app: JupyterFrontEnd,
   mainMenu: IMainMenu,
   palette: ICommandPalette | null,
-  restorer: ILayoutRestorer | null
+  restorer: ILayoutRestorer | null,
+  inspector: IInspector | null
 ): void {
   let counter = 0;
   const category = 'Help';
@@ -157,6 +160,13 @@ function activate(
     command => ({ command })
   );
   helpMenu.addGroup(labGroup, 0);
+
+  // Contextual help in its own group
+  const contextualHelpGroup = [inspector ? 'inspector:open' : null].map(
+    command => ({ command })
+  );
+  helpMenu.addGroup(contextualHelpGroup, 0);
+
   const resourcesGroup = RESOURCES.map(args => ({
     args,
     command: CommandIDs.open

diff --git a/packages/help-extension/style/index.css b/packages/help-extension/style/index.css
@@ -6,6 +6,7 @@
 /* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
 @import url('~@phosphor/widgets/style/index.css');
 @import url('~@jupyterlab/apputils/style/index.css');
+@import url('~@jupyterlab/inspector/style/index.css');
 @import url('~@jupyterlab/mainmenu/style/index.css');
 
 @import url('./base.css');
diff --git a/packages/help-extension/tsconfig.json b/packages/help-extension/tsconfig.json
@@ -15,6 +15,9 @@
     {
       "path": "../coreutils"
     },
+    {
+      "path": "../inspector"
+    },
     {
       "path": "../mainmenu"
     },

diff --git a/packages/inspector-extension/src/index.ts b/packages/inspector-extension/src/index.ts
@@ -50,8 +50,7 @@ const inspector: JupyterFrontEndPlugin<IInspector> = {
   ): IInspector => {
     const { commands, shell } = app;
     const command = CommandIDs.open;
-    const label = 'Open Contextual Help';
-    const title = 'Contextual Help';
+    const label = 'Contextual Help';
     const namespace = 'inspector';
     const tracker = new WidgetTracker<MainAreaWidget<InspectorPanel>>({
       namespace
@@ -63,7 +62,7 @@ const inspector: JupyterFrontEndPlugin<IInspector> = {
       if (!inspector || inspector.isDisposed) {
         inspector = new MainAreaWidget({ content: new InspectorPanel() });
         inspector.id = 'jp-inspector';
-        inspector.title.label = title;
+        inspector.title.label = label;
         void tracker.add(inspector);
         source = source && !source.isDisposed ? source : null;
         inspector.content.source = source;
@@ -83,15 +82,15 @@ const inspector: JupyterFrontEndPlugin<IInspector> = {
         inspector.isDisposed ||
         !inspector.isAttached ||
         !inspector.isVisible,
-      label: args => (args.isLauncher ? title : label),
+      label,
       iconClass: args =>
         args.isLauncher ? 'jp-MaterialIcon jp-InspectorIcon' : '',
       execute: () => openInspector()
     });
 
     // Add command to UI where possible.
     if (palette) {
-      palette.addItem({ command, category: title });
+      palette.addItem({ command, category: label });
     }
     if (launcher) {
       launcher.add({ command, args: { isLauncher: true } });

diff --git a/packages/mainmenu-extension/package.json b/packages/mainmenu-extension/package.json
@@ -39,7 +39,6 @@
     "@jupyterlab/application": "^1.0.0-alpha.13",
     "@jupyterlab/apputils": "^1.0.0-alpha.13",
     "@jupyterlab/coreutils": "^3.0.0-alpha.13",
-    "@jupyterlab/inspector": "^1.0.0-alpha.13",
     "@jupyterlab/mainmenu": "^1.0.0-alpha.13",
     "@jupyterlab/services": "^4.0.0-alpha.13",
     "@phosphor/algorithm": "^1.1.3",

diff --git a/packages/mainmenu-extension/src/index.ts b/packages/mainmenu-extension/src/index.ts
@@ -18,8 +18,6 @@ import { ICommandPalette, showDialog, Dialog } from '@jupyterlab/apputils';
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 
-import { IInspector } from '@jupyterlab/inspector';
-
 import {
   IMainMenu,
   IMenuExtender,
@@ -117,13 +115,12 @@ export namespace CommandIDs {
 const plugin: JupyterFrontEndPlugin<IMainMenu> = {
   id: '@jupyterlab/mainmenu-extension:plugin',
   requires: [ICommandPalette, IRouter],
-  optional: [IInspector, ILabShell],
+  optional: [ILabShell],
   provides: IMainMenu,
   activate: (
     app: JupyterFrontEnd,
     palette: ICommandPalette,
     router: IRouter,
-    inspector: IInspector | null,
     labShell: ILabShell | null
   ): IMainMenu => {
     const { commands } = app;
@@ -142,7 +139,7 @@ const plugin: JupyterFrontEndPlugin<IMainMenu> = {
 
     // Create the application menus.
     createEditMenu(app, menu.editMenu);
-    createFileMenu(app, menu.fileMenu, router, inspector);
+    createFileMenu(app, menu.fileMenu, router);
     createKernelMenu(app, menu.kernelMenu);
     createRunMenu(app, menu.runMenu);
     createSettingsMenu(app, menu.settingsMenu);
@@ -292,8 +289,7 @@ export function createEditMenu(app: JupyterFrontEnd, menu: EditMenu): void {
 export function createFileMenu(
   app: JupyterFrontEnd,
   menu: FileMenu,
-  router: IRouter,
-  inspector: IInspector | null
+  router: IRouter
 ): void {
   const commands = menu.menu.commands;
 
@@ -413,8 +409,7 @@ export function createFileMenu(
 
   const newViewGroup = [
     { command: 'docmanager:clone' },
-    { command: CommandIDs.createConsole },
-    inspector ? { command: 'inspector:open' } : null
+    { command: CommandIDs.createConsole }
   ].filter(item => !!item);
 
   // Add the close group

diff --git a/packages/mainmenu-extension/tsconfig.json b/packages/mainmenu-extension/tsconfig.json
@@ -15,9 +15,6 @@
     {
       "path": "../coreutils"
     },
-    {
-      "path": "../inspector"
-    },
     {
       "path": "../mainmenu"
     },