Add the restorer

Author: brichet

packages/application-extension/src/index.ts

@@ -3,11 +3,13 @@
 
 import {
   ILabStatus,
+  ILayoutRestorer,
   IRouter,
   ITreePathUpdater,
   JupyterFrontEnd,
   JupyterFrontEndPlugin,
   JupyterLab,
+  LayoutRestorer,
 } from '@jupyterlab/application';
 
 import {
@@ -16,7 +18,9 @@ import {
   ISanitizer,
   ISplashScreen,
   IToolbarWidgetRegistry,
+  IWindowResolver,
   showErrorMessage,
+  WindowResolver,
 } from '@jupyterlab/apputils';
 
 import { ConsolePanel } from '@jupyterlab/console';
@@ -40,6 +44,8 @@ import {
 
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
+import { IStateDB } from '@jupyterlab/statedb';
+
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 
 import {
@@ -176,6 +182,46 @@ const info: JupyterFrontEndPlugin<JupyterLab.IInfo> = {
   },
 };
 
+/**
+ * The default layout restorer provider.
+ */
+const layoutRestorer: JupyterFrontEndPlugin<ILayoutRestorer | null> = {
+  id: '@jupyter-notebook/application-extension:layout',
+  description: 'Provides the shell layout restorer.',
+  requires: [IStateDB],
+  optional: [INotebookShell],
+  activate: async (
+    app: JupyterFrontEnd,
+    state: IStateDB,
+    notebookShell: INotebookShell | null
+  ) => {
+    if (!notebookShell) {
+      console.log('No layout for this view');
+      return null;
+    }
+
+    const first = app.started;
+    const registry = app.commands;
+
+    const restorer = new LayoutRestorer({
+      connector: state,
+      first,
+      registry,
+    });
+
+    // Restore the layout.
+    void notebookShell.restoreLayout(restorer, {}).then(() => {
+      notebookShell.layoutModified.connect(() => {
+        void restorer.save(notebookShell.saveLayout());
+      });
+    });
+
+    return restorer;
+  },
+  autoStart: true,
+  provides: ILayoutRestorer,
+};
+
 /**
  * The logo plugin.
  */
@@ -465,6 +511,26 @@ const rendermime: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
   },
 };
 
+/**
+ * The default window name resolver provider.
+ */
+const resolver: JupyterFrontEndPlugin<IWindowResolver> = {
+  id: '@jupyter-notebook/apputils-extension:resolver',
+  description: 'Provides the window name resolver.',
+  autoStart: true,
+  provides: IWindowResolver,
+  requires: [JupyterFrontEnd.IPaths, IRouter],
+  activate: async (
+    app: JupyterFrontEnd,
+    paths: JupyterFrontEnd.IPaths,
+    router: IRouter
+  ) => {
+    const solver = new WindowResolver();
+    (solver as any)._name = 'nb-default';
+    return solver;
+  },
+};
+
 /**
  * The default Jupyter Notebook application shell.
  */
@@ -491,7 +557,7 @@ const shell: JupyterFrontEndPlugin<INotebookShell> = {
           const customLayout = settings.composite['layout'] as any;
 
           // Restore the layout.
-          void notebookShell.restoreLayout(customLayout);
+          void notebookShell.restoreLayoutConf(customLayout);
         })
         .catch((reason) => {
           console.error('Fail to load settings for the layout restorer.');
@@ -1189,6 +1255,7 @@ const zen: JupyterFrontEndPlugin<void> = {
 const plugins: JupyterFrontEndPlugin<any>[] = [
   dirty,
   info,
+  layoutRestorer,
   logo,
   menus,
   menuSpacer,
@@ -1197,6 +1264,7 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   pathOpener,
   paths,
   rendermime,
+  resolver,
   shell,
   sidePanelVisibility,
   shortcuts,

packages/application/src/panelhandler.ts

@@ -119,7 +119,7 @@ export class SidePanelHandler extends PanelHandler {
    * Whether the panel is visible
    */
   get isVisible(): boolean {
-    return this._panel.isVisible;
+    return this._currentWidget?.isVisible || false;
   }
 
   /**
@@ -150,6 +150,13 @@ export class SidePanelHandler extends PanelHandler {
     return this._widgetRemoved;
   }
 
+  /**
+   * A signal emitting when the panel closes.
+   */
+  get closed(): ISignal<SidePanelHandler, void> {
+    return this._closed;
+  }
+
   /**
    * Get the close button element.
    */
@@ -209,6 +216,7 @@ export class SidePanelHandler extends PanelHandler {
   collapse(): void {
     this._currentWidget?.hide();
     this._currentWidget = null;
+    this._closed.emit();
   }
 
   /**
@@ -245,6 +253,28 @@ export class SidePanelHandler extends PanelHandler {
     this._refreshVisibility();
   }
 
+  /**
+   * Dehydrate the panel layout.
+   */
+  dehydrate(): SidePanel.ISideArea {
+    return {
+      visible: this.isVisible,
+      currentWidget: this.currentWidget,
+    };
+  }
+
+  /**
+   * Rehydrate the panel.
+   */
+  rehydrate(data: SidePanel.ISideArea) {
+    if (data.currentWidget) {
+      this.activate(data.currentWidget.id);
+    }
+    if (data.visible) {
+      this.show();
+    }
+  }
+
   /**
    * Find the insertion index for a rank item.
    */
@@ -296,6 +326,7 @@ export class SidePanelHandler extends PanelHandler {
   private _closeButton: HTMLButtonElement;
   private _widgetAdded: Signal<SidePanelHandler, Widget> = new Signal(this);
   private _widgetRemoved: Signal<SidePanelHandler, Widget> = new Signal(this);
+  private _closed: Signal<SidePanelHandler, void> = new Signal(this);
 }
 
 /**
@@ -306,6 +337,21 @@ export namespace SidePanel {
    * The areas of the sidebar panel
    */
   export type Area = 'left' | 'right';
+
+  /**
+   * The restorable description of a sidebar in the user interface.
+   */
+  export interface ISideArea {
+    /**
+     * The current widget that has side area focus.
+     */
+    readonly currentWidget: Widget | null;
+
+    /**
+     * A flag denoting whether the side tab bar is visible.
+     */
+    readonly visible: boolean;
+  }
 }
 
 /**