@jupyter-notebook/help-extension 7.0.0-alpha.9 → 7.0.0-beta.1

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 { Dialog, ICommandPalette } from '@jupyterlab/apputils';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ITranslator } from '@jupyterlab/translation';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
@@ -11,12 +11,12 @@ import * as React from 'react';
 const RESOURCES = [
     {
         text: 'About Jupyter',
-        url: 'https://jupyter.org'
+        url: 'https://jupyter.org',
     },
     {
         text: 'Markdown Reference',
-        url: 'https://commonmark.org/help/'
-    }
+        url: 'https://commonmark.org/help/',
+    },
 ];
 /**
  * The command IDs used by the help plugin.
@@ -24,55 +24,37 @@ const RESOURCES = [
 var CommandIDs;
 (function (CommandIDs) {
     CommandIDs.open = 'help:open';
-    CommandIDs.shortcuts = 'help:shortcuts';
     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 => {
+            label: (args) => args['text'],
+            execute: (args) => {
                 const url = args['url'];
                 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: () => {
@@ -87,7 +69,7 @@ const plugin = {
                     React.createElement("a", { href: notebookURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat jp-AboutNotebook-about-externalLinks" }, aboutJupyter),
                     React.createElement("a", { href: contributorURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat jp-AboutNotebook-about-externalLinks" }, contributorList)));
                 const version = trans.__('Version: %1', app.version);
-                const copyright = trans.__('© 2021-2022 Jupyter Notebook Contributors');
+                const copyright = trans.__('© 2021-2023 Jupyter Notebook Contributors');
                 const body = (React.createElement(React.Fragment, null,
                     React.createElement("span", { className: "jp-AboutNotebook-version" }, version),
                     React.createElement("div", null, externalLinks),
@@ -98,21 +80,25 @@ const plugin = {
                     buttons: [
                         Dialog.createButton({
                             label: trans.__('Dismiss'),
-                            className: 'jp-AboutNotebook-about-button jp-mod-reject jp-mod-styled'
-                        })
-                    ]
+                            className: 'jp-AboutNotebook-about-button jp-mod-reject jp-mod-styled',
+                        }),
+                    ],
                 });
                 dialog.addClass('jp-AboutNotebook');
                 void dialog.launch();
-            }
+            },
         });
-        const resourcesGroup = RESOURCES.map(args => ({
+        if (palette) {
+            palette.addItem({ command: CommandIDs.about, category });
+        }
+        const resourcesGroup = RESOURCES.map((args) => ({
             args,
-            command: CommandIDs.open
+            command: CommandIDs.open,
         }));
         if (menu) {
             menu.helpMenu.addGroup(resourcesGroup, 30);
         }
-    }
+    },
 };
-export default plugin;
+const plugins = [open, about];
+export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/help-extension",
-  "version": "7.0.0-alpha.9",
+  "version": "7.0.0-beta.1",
   "description": "Jupyter Notebook - Help Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -35,19 +35,20 @@
     "build:prod": "tsc -b",
     "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
     "docs": "typedoc src",
-    "prepublishOnly": "npm run build",
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/ui-components": "^7.0.0-alpha.9",
-    "@jupyterlab/application": "^4.0.0-alpha.16",
-    "@jupyterlab/apputils": "^4.0.0-alpha.16",
-    "@jupyterlab/mainmenu": "^4.0.0-alpha.16",
-    "@jupyterlab/translation": "^4.0.0-alpha.16"
+    "@jupyter-notebook/ui-components": "^7.0.0-beta.1",
+    "@jupyterlab/application": "^4.0.0-rc.0",
+    "@jupyterlab/apputils": "^4.0.0-rc.0",
+    "@jupyterlab/mainmenu": "^4.0.0-rc.0",
+    "@jupyterlab/translation": "^4.0.0-rc.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",
-    "typescript": "~4.7.3"
+    "typescript": "~5.0.2"
   },
   "publishConfig": {
     "access": "public"

package/schema/{plugin.json → open.json}

@@ -13,10 +13,6 @@
           {
             "type": "separator",
             "rank": 1
-          },
-          {
-            "command": "help:shortcuts",
-            "rank": 20
           }
         ]
       }

package/style/base.css

@@ -52,16 +52,3 @@
 .jp-AboutNotebook-about-copyright {
   padding-top: 25px;
 }
-
-.jp-AboutNotebook-shortcuts {
-  padding: 10px;
-}
-
-.jp-AboutNotebook-shortcuts pre {
-  padding: 5px;
-  margin: 0 0 10px;
-  background: var(--jp-layout-color2);
-  border: 1px solid var(--jp-border-color0);
-  border-radius: 2px;
-  word-break: break-all;
-}