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

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+/**
+ * Export the plugins as default.
+ */
+declare const plugins: JupyterFrontEndPlugin<any>[];
+export default plugins;

package/lib/index.js

@@ -0,0 +1,142 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { ILabShell } from '@jupyterlab/application';
+import { ICommandPalette, IToolbarWidgetRegistry } from '@jupyterlab/apputils';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { IMainMenu } from '@jupyterlab/mainmenu';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { ITranslator } from '@jupyterlab/translation';
+import { Menu, MenuBar } from '@lumino/widgets';
+import { INotebookShell } from '@jupyter-notebook/application';
+/**
+ * The command IDs used by the application plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    /**
+     * Launch Jupyter Notebook Tree
+     */
+    CommandIDs.launchNotebookTree = 'jupyter-notebook:launch-tree';
+    /**
+     * Open Jupyter Notebook
+     */
+    CommandIDs.openNotebook = 'jupyter-notebook:open-notebook';
+    /**
+     * Open in JupyterLab
+     */
+    CommandIDs.openLab = 'jupyter-notebook:open-lab';
+})(CommandIDs || (CommandIDs = {}));
+/**
+ * A plugin to add custom toolbar items to the notebook page
+ */
+const launchButtons = {
+    id: '@jupyter-notebook/lab-extension:interface-switcher',
+    autoStart: true,
+    requires: [ITranslator],
+    optional: [
+        INotebookTracker,
+        ICommandPalette,
+        IMainMenu,
+        INotebookShell,
+        ILabShell,
+        IToolbarWidgetRegistry
+    ],
+    activate: (app, translator, notebookTracker, palette, menu, notebookShell, labShell, toolbarRegistry) => {
+        if (!notebookTracker) {
+            // to prevent showing the toolbar button in non-notebook pages
+            return;
+        }
+        const { commands, shell } = app;
+        const baseUrl = PageConfig.getBaseUrl();
+        const trans = translator.load('notebook');
+        const menubar = new MenuBar();
+        const switcher = new Menu({ commands });
+        switcher.title.label = trans.__('Interface');
+        menubar.addMenu(switcher);
+        const isEnabled = () => {
+            return (notebookTracker.currentWidget !== null &&
+                notebookTracker.currentWidget === shell.currentWidget);
+        };
+        const addInterface = (option) => {
+            const { command, commandLabel, urlPrefix } = option;
+            commands.addCommand(command, {
+                label: args => (args.noLabel ? '' : commandLabel),
+                caption: commandLabel,
+                execute: () => {
+                    const current = notebookTracker.currentWidget;
+                    if (!current) {
+                        return;
+                    }
+                    window.open(`${urlPrefix}${current.context.path}`);
+                },
+                isEnabled
+            });
+            if (palette) {
+                palette.addItem({ command, category: 'Other' });
+            }
+            if (menu) {
+                menu.viewMenu.addGroup([{ command }], 1);
+            }
+            switcher.addItem({ command });
+        };
+        if (!notebookShell) {
+            addInterface({
+                command: CommandIDs.openNotebook,
+                commandLabel: trans.__('Open With %1', 'Jupyter Notebook'),
+                buttonLabel: 'openNotebook',
+                urlPrefix: `${baseUrl}tree/`
+            });
+        }
+        if (!labShell) {
+            addInterface({
+                command: CommandIDs.openLab,
+                commandLabel: trans.__('Open With %1', 'JupyterLab'),
+                buttonLabel: 'openLab',
+                urlPrefix: `${baseUrl}doc/tree/`
+            });
+        }
+        if (toolbarRegistry) {
+            toolbarRegistry.registerFactory('Notebook', 'interfaceSwitcher', panel => {
+                const menubar = new MenuBar();
+                menubar.addMenu(switcher);
+                menubar.addClass('jp-InterfaceSwitcher');
+                return menubar;
+            });
+        }
+    }
+};
+/**
+ * A plugin to add a command to open the Jupyter Notebook Tree.
+ */
+const launchNotebookTree = {
+    id: '@jupyter-notebook/lab-extension:launch-tree',
+    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.launchNotebookTree, {
+            label: trans.__('Launch Jupyter Notebook File Browser'),
+            execute: () => {
+                window.open(PageConfig.getBaseUrl() + 'tree');
+            }
+        });
+        if (menu) {
+            const helpMenu = menu.helpMenu;
+            helpMenu.addGroup([{ command: CommandIDs.launchNotebookTree }], 1);
+        }
+        if (palette) {
+            palette.addItem({ command: CommandIDs.launchNotebookTree, category });
+        }
+    }
+};
+/**
+ * Export the plugins as default.
+ */
+const plugins = [
+    launchNotebookTree,
+    launchButtons
+];
+export default plugins;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@jupyter-notebook/lab-extension",
+  "version": "7.0.0-alpha.1",
+  "description": "Jupyter Notebook - Lab 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/index.js"
+  ],
+  "scripts": {
+    "build": "jlpm run build:lib && jlpm run build:labextension:dev",
+    "build:labextension": "jupyter labextension build .",
+    "build:labextension:dev": "jupyter labextension build --development True .",
+    "build:lib": "tsc",
+    "build:prod": "jlpm run build:lib && jlpm run build:labextension",
+    "clean": "jlpm run clean:lib && jlpm run clean:labextension",
+    "clean:labextension": "rimraf ../../notebook/labextension",
+    "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+    "watch": "run-p watch:src watch:labextension",
+    "watch:labextension": "jupyter labextension watch .",
+    "watch:src": "tsc -w"
+  },
+  "dependencies": {
+    "@jupyter-notebook/application": "^7.0.0-alpha.1",
+    "@jupyterlab/application": "^4.0.0-alpha.5",
+    "@jupyterlab/apputils": "^4.0.0-alpha.5",
+    "@jupyterlab/coreutils": "^6.0.0-alpha.5",
+    "@jupyterlab/docregistry": "^4.0.0-alpha.5",
+    "@jupyterlab/mainmenu": "^4.0.0-alpha.5",
+    "@jupyterlab/notebook": "^4.0.0-alpha.5",
+    "@jupyterlab/translation": "^4.0.0-alpha.4",
+    "@lumino/commands": "^1.20.0",
+    "@lumino/disposable": "^1.10.1"
+  },
+  "devDependencies": {
+    "@jupyterlab/builder": "^4.0.0-alpha.5",
+    "rimraf": "~3.0.0",
+    "typescript": "~4.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "extension": true,
+    "outputDir": "../../notebook/labextension",
+    "schemaDir": "schema"
+  },
+  "styleModule": "style/index.js"
+}

package/schema/interface-switcher.json

@@ -0,0 +1,10 @@
+{
+  "title": "Interface Switcher",
+  "description": "Interface Switcher settings.",
+  "jupyter.lab.toolbars": {
+    "Notebook": [{ "name": "interfaceSwitcher", "rank": 990 }]
+  },
+  "properties": {},
+  "additionalProperties": false,
+  "type": "object"
+}

package/style/index.js

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