@jupyter-notebook/application-extension 7.0.0-alpha.7 → 7.0.0-alpha.9

package/lib/index.js

@@ -9,12 +9,11 @@ import { DocumentWidget } from '@jupyterlab/docregistry';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ITranslator } from '@jupyterlab/translation';
-import { NotebookApp, NotebookShell, INotebookShell } from '@jupyter-notebook/application';
+import { NotebookApp, NotebookShell, INotebookShell, SidePanelPalette } from '@jupyter-notebook/application';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { DisposableDelegate, DisposableSet } from '@lumino/disposable';
 import { Menu, Widget } from '@lumino/widgets';
-import { SideBarPalette } from './sidebarpalette';
 /**
  * A regular expression to match path to notebooks and documents
  */
@@ -33,7 +32,7 @@ var CommandIDs;
      */
     CommandIDs.toggleTop = 'application:toggle-top';
     /**
-     * Toggle sidebar visibility
+     * Toggle side panel visibility
      */
     CommandIDs.togglePanel = 'application:toggle-panel';
     /**
@@ -431,10 +430,10 @@ const topVisibility = {
     autoStart: true
 };
 /**
- * Plugin to toggle the left or right sidebar's visibility.
+ * Plugin to toggle the left or right side panel's visibility.
  */
-const sidebarVisibility = {
-    id: '@jupyter-notebook/application-extension:sidebar',
+const sidePanelVisibility = {
+    id: '@jupyter-notebook/application-extension:sidepanel',
     requires: [INotebookShell, ITranslator],
     optional: [IMainMenu, ICommandPalette],
     autoStart: true,
@@ -443,7 +442,7 @@ const sidebarVisibility = {
         /* Arguments for togglePanel command:
          * side, left or right area
          * title, widget title to show in the menu
-         * id, widget ID to activate in the sidebar
+         * id, widget ID to activate in the side panel
          */
         app.commands.addCommand(CommandIDs.togglePanel, {
             label: args => args['title'],
@@ -517,15 +516,15 @@ const sidebarVisibility = {
                 return false;
             }
         });
-        const sideBarMenu = {
+        const sidePanelMenu = {
             left: null,
             right: null
         };
         /**
-         * The function which adds entries to the View menu for each widget of a sidebar.
+         * The function which adds entries to the View menu for each widget of a side panel.
          *
-         * @param area - 'left' or 'right', the area of the side bar.
-         * @param entryLabel - the name of the main entry in the View menu for that sidebar.
+         * @param area - 'left' or 'right', the area of the side panel.
+         * @param entryLabel - the name of the main entry in the View menu for that side panel.
          * @returns - The disposable menu added to the View menu or null.
          */
         const updateMenu = (area, entryLabel) => {
@@ -533,14 +532,14 @@ const sidebarVisibility = {
             if (menu === null) {
                 return null;
             }
-            // Remove the previous menu entry for this sidebar.
-            (_a = sideBarMenu[area]) === null || _a === void 0 ? void 0 : _a.dispose();
-            // Creates a new menu entry and populates it with sidebar widgets.
+            // Remove the previous menu entry for this side panel.
+            (_a = sidePanelMenu[area]) === null || _a === void 0 ? void 0 : _a.dispose();
+            // Creates a new menu entry and populates it with side panel widgets.
             const newMenu = new Menu({ commands: app.commands });
             newMenu.title.label = entryLabel;
             const widgets = notebookShell.widgets(area);
             let menuToAdd = false;
-            for (let widget of widgets) {
+            for (const widget of widgets) {
                 newMenu.addItem({
                     command: CommandIDs.togglePanel,
                     args: {
@@ -553,7 +552,7 @@ const sidebarVisibility = {
             }
             // If there are widgets, add the menu to the main menu entry.
             if (menuToAdd) {
-                sideBarMenu[area] = menu.viewMenu.addItem({
+                sidePanelMenu[area] = menu.viewMenu.addItem({
                     type: 'submenu',
                     submenu: newMenu
                 });
@@ -562,53 +561,53 @@ const sidebarVisibility = {
         app.restored.then(() => {
             // Create menu entries for the left and right panel.
             if (menu) {
-                const getSideBarLabel = (area) => {
+                const getSidePanelLabel = (area) => {
                     if (area === 'left') {
-                        return trans.__(`Left Sidebar`);
+                        return trans.__('Left Sidebar');
                     }
                     else {
-                        return trans.__(`Right Sidebar`);
+                        return trans.__('Right Sidebar');
                     }
                 };
                 const leftArea = notebookShell.leftHandler.area;
-                const leftLabel = getSideBarLabel(leftArea);
+                const leftLabel = getSidePanelLabel(leftArea);
                 updateMenu(leftArea, leftLabel);
                 const rightArea = notebookShell.rightHandler.area;
-                const rightLabel = getSideBarLabel(rightArea);
+                const rightLabel = getSidePanelLabel(rightArea);
                 updateMenu(rightArea, rightLabel);
-                const handleSideBarChange = (sidebar, widget) => {
-                    const label = getSideBarLabel(sidebar.area);
-                    updateMenu(sidebar.area, label);
+                const handleSidePanelChange = (sidePanel, widget) => {
+                    const label = getSidePanelLabel(sidePanel.area);
+                    updateMenu(sidePanel.area, label);
                 };
-                notebookShell.leftHandler.widgetAdded.connect(handleSideBarChange);
-                notebookShell.leftHandler.widgetRemoved.connect(handleSideBarChange);
-                notebookShell.rightHandler.widgetAdded.connect(handleSideBarChange);
-                notebookShell.rightHandler.widgetRemoved.connect(handleSideBarChange);
+                notebookShell.leftHandler.widgetAdded.connect(handleSidePanelChange);
+                notebookShell.leftHandler.widgetRemoved.connect(handleSidePanelChange);
+                notebookShell.rightHandler.widgetAdded.connect(handleSidePanelChange);
+                notebookShell.rightHandler.widgetRemoved.connect(handleSidePanelChange);
             }
             // Add palette entries for side panels.
             if (palette) {
-                const sideBarPalette = new SideBarPalette({
+                const sidePanelPalette = new SidePanelPalette({
                     commandPalette: palette,
                     command: CommandIDs.togglePanel
                 });
                 notebookShell.leftHandler.widgets.forEach(widget => {
-                    sideBarPalette.addItem(widget, notebookShell.leftHandler.area);
+                    sidePanelPalette.addItem(widget, notebookShell.leftHandler.area);
                 });
                 notebookShell.rightHandler.widgets.forEach(widget => {
-                    sideBarPalette.addItem(widget, notebookShell.rightHandler.area);
+                    sidePanelPalette.addItem(widget, notebookShell.rightHandler.area);
                 });
-                // Update menu and palette when widgets are added or removed from sidebars.
-                notebookShell.leftHandler.widgetAdded.connect((sidebar, widget) => {
-                    sideBarPalette.addItem(widget, sidebar.area);
+                // Update menu and palette when widgets are added or removed from side panels.
+                notebookShell.leftHandler.widgetAdded.connect((sidePanel, widget) => {
+                    sidePanelPalette.addItem(widget, sidePanel.area);
                 });
-                notebookShell.leftHandler.widgetRemoved.connect((sidebar, widget) => {
-                    sideBarPalette.removeItem(widget, sidebar.area);
+                notebookShell.leftHandler.widgetRemoved.connect((sidePanel, widget) => {
+                    sidePanelPalette.removeItem(widget, sidePanel.area);
                 });
-                notebookShell.rightHandler.widgetAdded.connect((sidebar, widget) => {
-                    sideBarPalette.addItem(widget, sidebar.area);
+                notebookShell.rightHandler.widgetAdded.connect((sidePanel, widget) => {
+                    sidePanelPalette.addItem(widget, sidePanel.area);
                 });
-                notebookShell.rightHandler.widgetRemoved.connect((sidebar, widget) => {
-                    sideBarPalette.removeItem(widget, sidebar.area);
+                notebookShell.rightHandler.widgetRemoved.connect((sidePanel, widget) => {
+                    sidePanelPalette.removeItem(widget, sidePanel.area);
                 });
             }
         });
@@ -735,7 +734,7 @@ const plugins = [
     paths,
     sessionDialogs,
     shell,
-    sidebarVisibility,
+    sidePanelVisibility,
     status,
     tabTitle,
     title,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application-extension",
-  "version": "7.0.0-alpha.7",
+  "version": "7.0.0-alpha.9",
   "description": "Jupyter Notebook - Application Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -39,19 +39,19 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.0.0-alpha.7",
-    "@jupyter-notebook/ui-components": "^7.0.0-alpha.7",
-    "@jupyterlab/application": "^4.0.0-alpha.15",
-    "@jupyterlab/apputils": "^4.0.0-alpha.15",
-    "@jupyterlab/celltags": "^4.0.0-alpha.15",
-    "@jupyterlab/codeeditor": "^4.0.0-alpha.15",
-    "@jupyterlab/console": "^4.0.0-alpha.15",
-    "@jupyterlab/coreutils": "^6.0.0-alpha.15",
-    "@jupyterlab/docmanager": "^4.0.0-alpha.15",
-    "@jupyterlab/docregistry": "^4.0.0-alpha.15",
-    "@jupyterlab/mainmenu": "^4.0.0-alpha.15",
-    "@jupyterlab/settingregistry": "^4.0.0-alpha.15",
-    "@jupyterlab/translation": "^4.0.0-alpha.15",
+    "@jupyter-notebook/application": "^7.0.0-alpha.9",
+    "@jupyter-notebook/ui-components": "^7.0.0-alpha.9",
+    "@jupyterlab/application": "^4.0.0-alpha.16",
+    "@jupyterlab/apputils": "^4.0.0-alpha.16",
+    "@jupyterlab/celltags": "^4.0.0-alpha.16",
+    "@jupyterlab/codeeditor": "^4.0.0-alpha.16",
+    "@jupyterlab/console": "^4.0.0-alpha.16",
+    "@jupyterlab/coreutils": "^6.0.0-alpha.16",
+    "@jupyterlab/docmanager": "^4.0.0-alpha.16",
+    "@jupyterlab/docregistry": "^4.0.0-alpha.16",
+    "@jupyterlab/mainmenu": "^4.0.0-alpha.16",
+    "@jupyterlab/settingregistry": "^4.0.0-alpha.16",
+    "@jupyterlab/translation": "^4.0.0-alpha.16",
     "@lumino/coreutils": "^2.0.0-alpha.6",
     "@lumino/disposable": "^2.0.0-alpha.6",
     "@lumino/widgets": "^2.0.0-alpha.6"

package/lib/sidebarpalette.d.ts

@@ -1,61 +0,0 @@
-import { ICommandPalette } from '@jupyterlab/apputils';
-import { IDisposable } from '@lumino/disposable';
-import { Widget } from '@lumino/widgets';
-/**
- * A class to manages the palette entries associated to the side bar.
- */
-export declare class SideBarPalette {
-    /**
-     * Construct a new side bar palette.
-     */
-    constructor(options: SideBarPaletteOption);
-    /**
-     * Get a command palette item from the widget id and the area.
-     */
-    getItem(widget: Readonly<Widget>, area: 'left' | 'right'): SideBarPaletteItem | null;
-    /**
-     * Add an item to the command palette.
-     */
-    addItem(widget: Readonly<Widget>, area: 'left' | 'right'): void;
-    /**
-     * Remove an item from the command palette.
-     */
-    removeItem(widget: Readonly<Widget>, area: 'left' | 'right'): void;
-    _command: string;
-    _commandPalette: ICommandPalette;
-    _items: SideBarPaletteItem[];
-}
-declare type SideBarPaletteItem = {
-    /**
-     * The ID of the widget associated to the command palette.
-     */
-    widgetId: string;
-    /**
-     * The area of the panel associated to the command palette.
-     */
-    area: 'left' | 'right';
-    /**
-     * The disposable object to remove the item from command palette.
-     */
-    disposable: IDisposable;
-};
-/**
- * An interface for the options to include in SideBarPalette constructor.
- */
-declare type SideBarPaletteOption = {
-    /**
-     * The commands palette.
-     */
-    commandPalette: ICommandPalette;
-    /**
-     * The command to call from each sidebar menu entry.
-     *
-     * ### Notes
-     * That command required 3 args :
-     *      side: 'left' | 'right', the area to toggle
-     *      title: string, label of the command
-     *      id: string, id of the widget to activate
-     */
-    command: string;
-};
-export {};

package/lib/sidebarpalette.js

@@ -1,61 +0,0 @@
-/**
- * A class to manages the palette entries associated to the side bar.
- */
-export class SideBarPalette {
-    /**
-     * Construct a new side bar palette.
-     */
-    constructor(options) {
-        this._items = [];
-        this._commandPalette = options.commandPalette;
-        this._command = options.command;
-    }
-    /**
-     * Get a command palette item from the widget id and the area.
-     */
-    getItem(widget, area) {
-        const itemList = this._items;
-        for (let i = 0; i < itemList.length; i++) {
-            const item = itemList[i];
-            if (item.widgetId == widget.id && item.area == area) {
-                return item;
-            }
-        }
-        return null;
-    }
-    /**
-     * Add an item to the command palette.
-     */
-    addItem(widget, area) {
-        // Check if the item does not already exist.
-        if (this.getItem(widget, area)) {
-            return;
-        }
-        // Add a new item in command palette.
-        const disposableDelegate = this._commandPalette.addItem({
-            command: this._command,
-            category: 'View',
-            args: {
-                side: area,
-                title: `Show ${widget.title.caption}`,
-                id: widget.id
-            }
-        });
-        // Keep the disposableDelegate objet to be able to dispose of the item if the widget
-        // is remove from the side bar.
-        this._items.push({
-            widgetId: widget.id,
-            area: area,
-            disposable: disposableDelegate
-        });
-    }
-    /**
-     * Remove an item from the command palette.
-     */
-    removeItem(widget, area) {
-        const item = this.getItem(widget, area);
-        if (item) {
-            item.disposable.dispose();
-        }
-    }
-}