@jupyter-notebook/application 7.0.0-beta.4 → 7.0.0-rc.0

package/lib/shell.d.ts

@@ -14,6 +14,37 @@ export declare const INotebookShell: Token<INotebookShell>;
  */
 export interface INotebookShell extends NotebookShell {
 }
+/**
+ * The namespace for INotebookShell type information.
+ */
+export declare namespace INotebookShell {
+    /**
+     * The areas of the application shell where widgets can reside.
+     */
+    type Area = 'main' | 'top' | 'menu' | 'left' | 'right';
+    /**
+     * Widget position
+     */
+    interface IWidgetPosition {
+        /**
+         * Widget area
+         */
+        area?: Area;
+        /**
+         * Widget opening options
+         */
+        options?: DocumentRegistry.IOpenOptions;
+    }
+    /**
+     * Mapping of widget type identifier and their user customized position
+     */
+    interface IUserLayout {
+        /**
+         * Widget customized position
+         */
+        [k: string]: IWidgetPosition;
+    }
+}
 /**
  * The application shell.
  */
@@ -60,6 +91,10 @@ export declare class NotebookShell extends Widget implements JupyterFrontEnd.ISh
      */
     get translator(): ITranslator;
     set translator(value: ITranslator);
+    /**
+     * User custom shell layout.
+     */
+    get userLayout(): any;
     /**
      * Activate a widget in its area.
      */
@@ -75,7 +110,7 @@ export declare class NotebookShell extends Widget implements JupyterFrontEnd.ISh
      * @param options - Optional open options.
      *
      */
-    add(widget: Widget, area?: Shell.Area, options?: DocumentRegistry.IOpenOptions): void;
+    add(widget: Widget, area?: INotebookShell.Area, options?: DocumentRegistry.IOpenOptions): void;
     /**
      * Collapse the top area and the spacer to make the view more compact.
      */
@@ -89,7 +124,7 @@ export declare class NotebookShell extends Widget implements JupyterFrontEnd.ISh
      *
      * @param area The area
      */
-    widgets(area: Shell.Area): IterableIterator<Widget>;
+    widgets(area: INotebookShell.Area): IterableIterator<Widget>;
     /**
      * Expand the left panel to show the sidebar with its widget.
      */
@@ -106,6 +141,10 @@ export declare class NotebookShell extends Widget implements JupyterFrontEnd.ISh
      * Collapse the right panel
      */
     collapseRight(): void;
+    /**
+     * Restore the layout state and configuration for the application shell.
+     */
+    restoreLayout(configuration: INotebookShell.IUserLayout): Promise<void>;
     private _topWrapper;
     private _topHandler;
     private _menuWrapper;
@@ -119,15 +158,7 @@ export declare class NotebookShell extends Widget implements JupyterFrontEnd.ISh
     private _translator;
     private _currentChanged;
     private _mainWidgetLoaded;
-}
-/**
- * A namespace for Shell statics
- */
-export declare namespace Shell {
-    /**
-     * The areas of the application shell where widgets can reside.
-     */
-    type Area = 'main' | 'top' | 'left' | 'right' | 'menu';
+    private _userLayout;
 }
 export declare namespace Private {
     class SkipLinkWidgetHandler {

package/lib/shell.js

@@ -2,7 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 import { nullTranslator } from '@jupyterlab/translation';
 import { find } from '@lumino/algorithm';
-import { PromiseDelegate, Token } from '@lumino/coreutils';
+import { JSONExt, PromiseDelegate, Token } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { BoxLayout, Panel, SplitPanel, Widget } from '@lumino/widgets';
 import { PanelHandler, SidePanelHandler } from './panelhandler';
@@ -24,6 +24,7 @@ export class NotebookShell extends Widget {
         this._currentChanged = new Signal(this);
         this._mainWidgetLoaded = new PromiseDelegate();
         this.id = 'main';
+        this._userLayout = {};
         this._topHandler = new PanelHandler();
         this._menuHandler = new PanelHandler();
         this._leftHandler = new SidePanelHandler('left');
@@ -164,6 +165,12 @@ export class NotebookShell extends Widget {
             this._rightHandler.closeButton.title = trans.__('Collapse %1 side panel', this._rightHandler.area);
         }
     }
+    /**
+     * User custom shell layout.
+     */
+    get userLayout() {
+        return JSONExt.deepCopy(this._userLayout);
+    }
     /**
      * Activate a widget in its area.
      */
@@ -196,8 +203,23 @@ export class NotebookShell extends Widget {
      *
      */
     add(widget, area, options) {
-        var _a;
-        const rank = (_a = options === null || options === void 0 ? void 0 : options.rank) !== null && _a !== void 0 ? _a : DEFAULT_RANK;
+        var _a, _b;
+        let userPosition;
+        if ((options === null || options === void 0 ? void 0 : options.type) && this._userLayout[options.type]) {
+            userPosition = this._userLayout[options.type];
+        }
+        else {
+            userPosition = this._userLayout[widget.id];
+        }
+        area = (_a = userPosition === null || userPosition === void 0 ? void 0 : userPosition.area) !== null && _a !== void 0 ? _a : area;
+        options =
+            options || (userPosition === null || userPosition === void 0 ? void 0 : userPosition.options)
+                ? {
+                    ...options,
+                    ...userPosition === null || userPosition === void 0 ? void 0 : userPosition.options,
+                }
+                : undefined;
+        const rank = (_b = options === null || options === void 0 ? void 0 : options.rank) !== null && _b !== void 0 ? _b : DEFAULT_RANK;
         switch (area) {
             case 'top':
                 return this._topHandler.addWidget(widget, rank);
@@ -291,6 +313,12 @@ export class NotebookShell extends Widget {
         this._rightHandler.collapse();
         this._rightHandler.panel.hide();
     }
+    /**
+     * Restore the layout state and configuration for the application shell.
+     */
+    async restoreLayout(configuration) {
+        this._userLayout = configuration;
+    }
 }
 export var Private;
 (function (Private) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application",
-  "version": "7.0.0-beta.4",
+  "version": "7.0.0-rc.0",
   "description": "Jupyter Notebook - Application",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -42,11 +42,11 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/application": "^4.0.1",
-    "@jupyterlab/coreutils": "^6.0.1",
-    "@jupyterlab/docregistry": "^4.0.1",
-    "@jupyterlab/rendermime-interfaces": "^3.8.1",
-    "@jupyterlab/ui-components": "^4.0.1",
+    "@jupyterlab/application": "^4.0.2",
+    "@jupyterlab/coreutils": "^6.0.2",
+    "@jupyterlab/docregistry": "^4.0.2",
+    "@jupyterlab/rendermime-interfaces": "^3.8.2",
+    "@jupyterlab/ui-components": "^4.0.2",
     "@lumino/algorithm": "^2.0.0",
     "@lumino/coreutils": "^2.1.1",
     "@lumino/messaging": "^2.0.0",
@@ -57,7 +57,7 @@
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.12.1",
-    "@jupyterlab/testutils": "^4.0.1",
+    "@jupyterlab/testutils": "^4.0.2",
     "@types/jest": "^29.2.5",
     "jest": "^29.3.1",
     "rimraf": "^3.0.2",