@jupyter-notebook/help-extension 7.0.0-alpha.10 → 7.0.0-alpha.12

package/lib/index.d.ts

@@ -1,6 +1,3 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
-/**
- * The help plugin.
- */
-declare const plugin: JupyterFrontEndPlugin<void>;
-export default plugin;
+declare const plugins: JupyterFrontEndPlugin<any>[];
+export default plugins;

package/lib/index.js

@@ -1,6 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { showDialog, Dialog } from '@jupyterlab/apputils';
+import { showDialog, Dialog, ICommandPalette } from '@jupyterlab/apputils';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ITranslator } from '@jupyterlab/translation';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
@@ -28,16 +28,13 @@ var CommandIDs;
     CommandIDs.about = 'help:about';
 })(CommandIDs || (CommandIDs = {}));
 /**
- * The help plugin.
+ * A plugin to open the about section with resources.
  */
-const plugin = {
-    id: '@jupyter-notebook/help-extension:plugin',
+const open = {
+    id: '@jupyter-notebook/help-extension:open',
     autoStart: true,
-    requires: [ITranslator],
-    optional: [IMainMenu],
-    activate: (app, translator, menu) => {
+    activate: (app) => {
         const { commands } = app;
-        const trans = translator.load('notebook');
         commands.addCommand(CommandIDs.open, {
             label: args => args['text'],
             execute: args => {
@@ -45,34 +42,20 @@ const plugin = {
                 window.open(url);
             }
         });
-        commands.addCommand(CommandIDs.shortcuts, {
-            label: trans.__('Keyboard Shortcuts'),
-            execute: () => {
-                const title = (React.createElement("span", { className: "jp-AboutNotebook-about-header" },
-                    React.createElement("div", { className: "jp-AboutNotebook-about-header-info" }, trans.__('Keyboard Shortcuts'))));
-                const body = (React.createElement("table", { className: "jp-AboutNotebook-shortcuts" },
-                    React.createElement("thead", null,
-                        React.createElement("tr", null,
-                            React.createElement("th", null, trans.__('Name')),
-                            React.createElement("th", null, trans.__('Shortcut')))),
-                    React.createElement("tbody", null, commands.keyBindings
-                        .filter(binding => commands.isEnabled(binding.command))
-                        .map((binding, i) => (React.createElement("tr", { key: i },
-                        React.createElement("td", null, commands.label(binding.command)),
-                        React.createElement("td", null,
-                            React.createElement("pre", null, binding.keys.join(', ')))))))));
-                return showDialog({
-                    title,
-                    body,
-                    buttons: [
-                        Dialog.createButton({
-                            label: trans.__('Dismiss'),
-                            className: 'jp-AboutNotebook-about-button jp-mod-reject jp-mod-styled'
-                        })
-                    ]
-                });
-            }
-        });
+    }
+};
+/**
+ * Plugin to add a command to show an About Jupyter Notebook and Markdown Reference.
+ */
+const about = {
+    id: '@jupyter-notebook/help-extension:about',
+    autoStart: true,
+    requires: [ITranslator],
+    optional: [IMainMenu, ICommandPalette],
+    activate: (app, translator, menu, palette) => {
+        const { commands } = app;
+        const trans = translator.load('notebook');
+        const category = trans.__('Help');
         commands.addCommand(CommandIDs.about, {
             label: trans.__('About %1', app.name),
             execute: () => {
@@ -106,6 +89,9 @@ const plugin = {
                 void dialog.launch();
             }
         });
+        if (palette) {
+            palette.addItem({ command: CommandIDs.about, category });
+        }
         const resourcesGroup = RESOURCES.map(args => ({
             args,
             command: CommandIDs.open
@@ -115,4 +101,50 @@ const plugin = {
         }
     }
 };
-export default plugin;
+/**
+ * A plugin to add a command to display Keyboard Shortcuts.
+ */
+const shortcuts = {
+    id: '@jupyter-notebook/help-extension:shortcuts',
+    autoStart: true,
+    requires: [ITranslator],
+    optional: [ICommandPalette],
+    activate: (app, translator, palette) => {
+        const { commands } = app;
+        const trans = translator.load('notebook');
+        const category = trans.__('Help');
+        commands.addCommand(CommandIDs.shortcuts, {
+            label: trans.__('Keyboard Shortcuts'),
+            execute: () => {
+                const title = (React.createElement("span", { className: "jp-AboutNotebook-about-header" },
+                    React.createElement("div", { className: "jp-AboutNotebook-about-header-info" }, trans.__('Keyboard Shortcuts'))));
+                const body = (React.createElement("table", { className: "jp-AboutNotebook-shortcuts" },
+                    React.createElement("thead", null,
+                        React.createElement("tr", null,
+                            React.createElement("th", null, trans.__('Name')),
+                            React.createElement("th", null, trans.__('Shortcut')))),
+                    React.createElement("tbody", null, commands.keyBindings
+                        .filter(binding => commands.isEnabled(binding.command))
+                        .map((binding, i) => (React.createElement("tr", { key: i },
+                        React.createElement("td", null, commands.label(binding.command)),
+                        React.createElement("td", null,
+                            React.createElement("pre", null, binding.keys.join(', ')))))))));
+                return showDialog({
+                    title,
+                    body,
+                    buttons: [
+                        Dialog.createButton({
+                            label: trans.__('Dismiss'),
+                            className: 'jp-AboutNotebook-about-button jp-mod-reject jp-mod-styled'
+                        })
+                    ]
+                });
+            }
+        });
+        if (palette) {
+            palette.addItem({ command: CommandIDs.shortcuts, category });
+        }
+    }
+};
+const plugins = [open, shortcuts, about];
+export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/help-extension",
-  "version": "7.0.0-alpha.10",
+  "version": "7.0.0-alpha.12",
   "description": "Jupyter Notebook - Help Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -39,13 +39,16 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/ui-components": "^7.0.0-alpha.10",
-    "@jupyterlab/application": "^4.0.0-alpha.17",
-    "@jupyterlab/apputils": "^4.0.0-alpha.17",
-    "@jupyterlab/mainmenu": "^4.0.0-alpha.17",
-    "@jupyterlab/translation": "^4.0.0-alpha.17"
+    "@jupyter-notebook/ui-components": "^7.0.0-alpha.12",
+    "@jupyterlab/application": "^4.0.0-alpha.18",
+    "@jupyterlab/apputils": "^4.0.0-alpha.18",
+    "@jupyterlab/mainmenu": "^4.0.0-alpha.18",
+    "@jupyterlab/translation": "^4.0.0-alpha.18",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@types/react": "^18.0.27",
     "rimraf": "^3.0.2",
     "typescript": "~4.9.3"
   },