@jupyter-notebook/help-extension 7.0.0-alpha.1

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,114 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { showDialog, Dialog } from '@jupyterlab/apputils';
+import { IMainMenu } from '@jupyterlab/mainmenu';
+import { ITranslator } from '@jupyterlab/translation';
+import { jupyterIcon } from '@jupyter-notebook/ui-components';
+import * as React from 'react';
+/**
+ * A list of resources to show in the help menu.
+ */
+const RESOURCES = [
+    {
+        text: 'About Jupyter',
+        url: 'https://jupyter.org'
+    },
+    {
+        text: 'Markdown Reference',
+        url: 'https://commonmark.org/help/'
+    }
+];
+/**
+ * The command IDs used by the help plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    CommandIDs.open = 'help:open';
+    CommandIDs.shortcuts = 'help:shortcuts';
+    CommandIDs.about = 'help:about';
+})(CommandIDs || (CommandIDs = {}));
+/**
+ * The help plugin.
+ */
+const plugin = {
+    id: '@jupyter-notebook/help-extension:plugin',
+    autoStart: true,
+    requires: [ITranslator],
+    optional: [IMainMenu],
+    activate: (app, translator, menu) => {
+        const { commands } = app;
+        const trans = translator.load('notebook');
+        commands.addCommand(CommandIDs.open, {
+            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'
+                        })
+                    ]
+                });
+            }
+        });
+        commands.addCommand(CommandIDs.about, {
+            label: trans.__('About %1', app.name),
+            execute: () => {
+                const title = (React.createElement(React.Fragment, null,
+                    React.createElement("span", { className: "jp-AboutNotebook-header" },
+                        React.createElement(jupyterIcon.react, { width: "196px", height: "auto" }))));
+                const notebookURL = 'https://github.com/jupyter/notebook';
+                const linkLabel = trans.__('JUPYTER NOTEBOOK ON GITHUB');
+                const externalLinks = (React.createElement("span", null,
+                    React.createElement("a", { href: notebookURL, target: "_blank", rel: "noopener noreferrer", className: "jp-Button-flat jp-AboutNotebook-about-externalLinks" }, linkLabel)));
+                const version = trans.__('Version: %1', app.version);
+                const body = (React.createElement(React.Fragment, null,
+                    React.createElement("span", { className: "jp-AboutNotebook-body" }, version),
+                    React.createElement("div", null, externalLinks)));
+                const dialog = new Dialog({
+                    title,
+                    body,
+                    buttons: [
+                        Dialog.createButton({
+                            label: trans.__('Dismiss'),
+                            className: 'jp-AboutNotebook-about-button jp-mod-reject jp-mod-styled'
+                        })
+                    ]
+                });
+                dialog.addClass('jp-AboutNotebook');
+                void dialog.launch();
+            }
+        });
+        const resourcesGroup = RESOURCES.map(args => ({
+            args,
+            command: CommandIDs.open
+        }));
+        if (menu) {
+            menu.helpMenu.addGroup([{ command: CommandIDs.shortcuts }]);
+            menu.helpMenu.addGroup(resourcesGroup);
+        }
+    }
+};
+export default plugin;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@jupyter-notebook/help-extension",
+  "version": "7.0.0-alpha.1",
+  "description": "Jupyter Notebook - Help Extension",
+  "homepage": "https://github.com/jupyter/notebook",
+  "bugs": {
+    "url": "https://github.com/jupyter/notebook/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyter/notebook.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "sideEffects": [
+    "style/**/*.css",
+    "style/index.js"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/*.d.ts",
+    "lib/*.js.map",
+    "lib/*.js",
+    "schema/*.json",
+    "style/**/*.css",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "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.1",
+    "@jupyterlab/application": "^4.0.0-alpha.5",
+    "@jupyterlab/apputils": "^4.0.0-alpha.5",
+    "@jupyterlab/mainmenu": "^4.0.0-alpha.5",
+    "@jupyterlab/translation": "^4.0.0-alpha.4"
+  },
+  "devDependencies": {
+    "rimraf": "~3.0.0",
+    "typescript": "~4.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "extension": true
+  },
+  "styleModule": "style/index.js"
+}

package/style/base.css

@@ -0,0 +1,51 @@
+.jp-AboutNotebook .jp-Dialog-header {
+  justify-content: center;
+}
+
+.jp-AboutNotebook-header {
+  display: flex;
+  flex-direction: row;
+  align-items: center;
+  padding: var(--jp-flat-button-padding);
+}
+
+.jp-AboutNotebook-header-text {
+  margin-left: 16px;
+}
+
+.jp-AboutNotebook-body {
+  display: flex;
+  font-size: var(--jp-ui-font-size2);
+  padding: var(--jp-flat-button-padding);
+  color: var(--jp-ui-font-color1);
+  text-align: left;
+  flex-direction: column;
+  min-width: 360px;
+  overflow: hidden;
+}
+
+.jp-AboutNotebook-about-body pre {
+  white-space: pre-wrap;
+}
+
+.jp-AboutNotebook-about-externalLinks {
+  display: flex;
+  flex-direction: column;
+  justify-content: flex-start;
+  align-items: flex-start;
+  padding-top: 12px;
+  color: var(--jp-warn-color0);
+}
+
+.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;
+}

package/style/index.css

@@ -0,0 +1 @@
+@import url('./base.css');

package/style/index.js

@@ -0,0 +1 @@
+import './base.css';