Merge pull request #7665 from blink1073/property-inspector

Add a Property Inspector
jupyterlab · Dec 23, 2019 · 23f8163 · 23f8163
2 parents 5167b6e + 1652272
commit 23f8163
Show file tree

Hide file tree

Showing 18 changed files with 525 additions and 48 deletions.
diff --git a/buildutils/src/ensure-package.ts b/buildutils/src/ensure-package.ts
@@ -193,6 +193,9 @@ export async function ensurePackage(
 
     // write out cssIndexContents, if needed
     const cssIndexPath = path.join(pkgPath, 'style/index.css');
+    if (!fs.existsSync(cssIndexPath)) {
+      fs.ensureFileSync(cssIndexPath);
+    }
     messages.push(...ensureFile(cssIndexPath, cssIndexContents, false));
   }
 

diff --git a/dev_mode/package.json b/dev_mode/package.json
@@ -143,6 +143,7 @@
     "@jupyterlab/observables": "~3.0.0-alpha.4",
     "@jupyterlab/outputarea": "~2.0.0-alpha.4",
     "@jupyterlab/pdf-extension": "~2.0.0-alpha.4",
+    "@jupyterlab/property-inspector": "~2.0.0-alpha.4",
     "@jupyterlab/rendermime": "~2.0.0-alpha.4",
     "@jupyterlab/rendermime-extension": "~2.0.0-alpha.4",
     "@jupyterlab/rendermime-interfaces": "~2.0.0-alpha.4",
@@ -328,6 +329,7 @@
       "@jupyterlab/observables": "../packages/observables",
       "@jupyterlab/outputarea": "../packages/outputarea",
       "@jupyterlab/pdf-extension": "../packages/pdf-extension",
+      "@jupyterlab/property-inspector": "../packages/property-inspector",
       "@jupyterlab/rendermime": "../packages/rendermime",
       "@jupyterlab/rendermime-extension": "../packages/rendermime-extension",
       "@jupyterlab/rendermime-interfaces": "../packages/rendermime-interfaces",

diff --git a/packages/application-extension/package.json b/packages/application-extension/package.json
@@ -39,6 +39,7 @@
     "@jupyterlab/application": "^2.0.0-alpha.4",
     "@jupyterlab/apputils": "^2.0.0-alpha.4",
     "@jupyterlab/coreutils": "^4.0.0-alpha.4",
+    "@jupyterlab/property-inspector": "^2.0.0-alpha.4",
     "@lumino/algorithm": "^1.2.1",
     "@lumino/coreutils": "^1.4.0",
     "@lumino/disposable": "^1.3.2",

diff --git a/packages/application-extension/src/index.tsx b/packages/application-extension/src/index.tsx
@@ -31,6 +31,11 @@ import {
   URLExt
 } from '@jupyterlab/coreutils';
 
+import {
+  IPropertyInspectorProvider,
+  SideBarPropertyInspectorProvider
+} from '@jupyterlab/property-inspector';
+
 import { each, iter, toArray } from '@lumino/algorithm';
 
 import { PromiseDelegate } from '@lumino/coreutils';
@@ -793,6 +798,24 @@ const paths: JupyterFrontEndPlugin<JupyterFrontEnd.IPaths> = {
   provides: JupyterFrontEnd.IPaths
 };
 
+/**
+ * The default property inspector provider.
+ */
+const propertyInspector: JupyterFrontEndPlugin<IPropertyInspectorProvider> = {
+  id: '@jupyterlab/application-extension:property-inspector',
+  autoStart: true,
+  requires: [ILabShell],
+  provides: IPropertyInspectorProvider,
+  activate: (app: JupyterFrontEnd, labshell: ILabShell) => {
+    const widget = new SideBarPropertyInspectorProvider(labshell);
+    widget.title.iconClass = 'jp-BuildIcon jp-SideBar-tabIcon';
+    widget.title.caption = 'Property Inspector';
+    widget.id = 'jp-property-inspector';
+    labshell.add(widget, 'left');
+    return widget;
+  }
+};
+
 /**
  * Export the plugins as default.
  */
@@ -807,7 +830,8 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   shell,
   status,
   info,
-  paths
+  paths,
+  propertyInspector
 ];
 
 export default plugins;
diff --git a/packages/application-extension/style/base.css b/packages/application-extension/style/base.css
@@ -0,0 +1,5 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+|
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
diff --git a/packages/application-extension/style/index.css b/packages/application-extension/style/index.css
@@ -1,7 +1,11 @@
 /*-----------------------------------------------------------------------------
-| Copyright (c) 2014-2017, Jupyter Development Team.
-|
+| Copyright (c) Jupyter Development Team.
 | Distributed under the terms of the Modified BSD License.
 |----------------------------------------------------------------------------*/
 
+/* This file was auto-generated by ensurePackage() in @jupyterlab/buildutils */
+@import url('~@lumino/widgets/style/index.css');
 @import url('~@jupyterlab/application/style/index.css');
+@import url('~@jupyterlab/property-inspector/style/index.css');
+
+@import url('./base.css');
diff --git a/packages/application-extension/tsconfig.json b/packages/application-extension/tsconfig.json
@@ -14,6 +14,9 @@
     },
     {
       "path": "../coreutils"
+    },
+    {
+      "path": "../property-inspector"
     }
   ]
 }
diff --git a/packages/metapackage/package.json b/packages/metapackage/package.json
@@ -86,6 +86,7 @@
     "@jupyterlab/observables": "^3.0.0-alpha.4",
     "@jupyterlab/outputarea": "^2.0.0-alpha.4",
     "@jupyterlab/pdf-extension": "^2.0.0-alpha.4",
+    "@jupyterlab/property-inspector": "^2.0.0-alpha.4",
     "@jupyterlab/rendermime": "^2.0.0-alpha.4",
     "@jupyterlab/rendermime-extension": "^2.0.0-alpha.4",
     "@jupyterlab/rendermime-interfaces": "^2.0.0-alpha.4",

diff --git a/packages/metapackage/tsconfig.json b/packages/metapackage/tsconfig.json
@@ -168,6 +168,9 @@
     {
       "path": "../pdf-extension"
     },
+    {
+      "path": "../property-inspector"
+    },
     {
       "path": "../rendermime"
     },

diff --git a/packages/notebook-extension/package.json b/packages/notebook-extension/package.json
@@ -46,6 +46,7 @@
     "@jupyterlab/launcher": "^2.0.0-alpha.4",
     "@jupyterlab/mainmenu": "^2.0.0-alpha.4",
     "@jupyterlab/notebook": "^2.0.0-alpha.4",
+    "@jupyterlab/property-inspector": "^2.0.0-alpha.4",
     "@jupyterlab/rendermime": "^2.0.0-alpha.4",
     "@jupyterlab/services": "^5.0.0-alpha.4",
     "@jupyterlab/statusbar": "^2.0.0-alpha.4",

diff --git a/packages/notebook-extension/src/index.ts b/packages/notebook-extension/src/index.ts
@@ -70,13 +70,15 @@ import {
   NotebookTrustStatus
 } from '@jupyterlab/notebook';
 
+import { IPropertyInspectorProvider } from '@jupyterlab/property-inspector';
+
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 
 import { ServiceManager } from '@jupyterlab/services';
 
 import { IStatusBar } from '@jupyterlab/statusbar';
 
-import { ReadonlyJSONObject, JSONValue } from '@lumino/coreutils';
+import { JSONValue } from '@lumino/coreutils';
 
 import { Message, MessageLoop } from '@lumino/messaging';
 
@@ -232,11 +234,6 @@ const NOTEBOOK_ICON_CLASS = 'jp-NotebookIcon';
  */
 const FACTORY = 'Notebook';
 
-/**
- * The rank of the notebook tools tab in the sidebar
- */
-const NOTEBOOK_TOOLS_RANK = 400;
-
 /**
  * The exluded Export To ...
  * (returned from nbconvert's export list)
@@ -309,7 +306,7 @@ const tools: JupyterFrontEndPlugin<INotebookTools> = {
   id: '@jupyterlab/notebook-extension:tools',
   autoStart: true,
   requires: [INotebookTracker, IEditorServices, IStateDB],
-  optional: [ILabShell]
+  optional: [ILabShell, IPropertyInspectorProvider]
 };
 
 /**
@@ -411,7 +408,8 @@ function activateNotebookTools(
   tracker: INotebookTracker,
   editorServices: IEditorServices,
   state: IStateDB,
-  labShell: ILabShell | null
+  labShell: ILabShell | null,
+  inspectorProvider: IPropertyInspectorProvider | null
 ): INotebookTools {
   const id = 'notebook-tools';
   const notebookTools = new NotebookTools({ tracker });
@@ -481,44 +479,12 @@ function activateNotebookTools(
 
   MessageLoop.installMessageHook(notebookTools, hook);
 
-  // Wait until the application has finished restoring before rendering.
-  void Promise.all([state.fetch(id), app.restored]).then(([value]) => {
-    const open = !!(
-      value && ((value as ReadonlyJSONObject)['open'] as boolean)
-    );
-
-    // After initial restoration, check if the notebook tools should render.
-    if (tracker.size) {
-      app.shell.add(notebookTools, 'left', { rank: NOTEBOOK_TOOLS_RANK });
-      if (open) {
-        app.shell.activateById(notebookTools.id);
-      }
-    }
-
-    const updateTools = () => {
-      // If there are any open notebooks, add notebook tools to the side panel if
-      // it is not already there.
-      if (labShell && tracker.size) {
-        if (!notebookTools.isAttached) {
-          labShell.add(notebookTools, 'left', { rank: NOTEBOOK_TOOLS_RANK });
-        }
-        return;
-      }
-      // If there are no notebooks, close notebook tools.
-      notebookTools.close();
-    };
-
-    // For all subsequent widget changes, check if the notebook tools should render.
-    if (labShell) {
-      labShell.currentChanged.connect((sender, args) => {
-        updateTools();
-      });
-    }
-    // A notebook widget could be closed without a change to labShell.currentWidget
-    tracker.currentChanged.connect((sender, args) => {
-      updateTools();
+  if (inspectorProvider) {
+    tracker.widgetAdded.connect((sender, panel) => {
+      const inspector = inspectorProvider.register(panel);
+      inspector.render(notebookTools);
     });
-  });
+  }
 
   return notebookTools;
 }

diff --git a/packages/notebook-extension/tsconfig.json b/packages/notebook-extension/tsconfig.json
@@ -36,6 +36,9 @@
     {
       "path": "../notebook"
     },
+    {
+      "path": "../property-inspector"
+    },
     {
       "path": "../rendermime"
     },

diff --git a/packages/property-inspector/package.json b/packages/property-inspector/package.json
@@ -0,0 +1,51 @@
+{
+  "name": "@jupyterlab/property-inspector",
+  "version": "2.0.0-alpha.4",
+  "description": "A property inspector display for widgets",
+  "homepage": "https://github.com/jupyterlab/jupyterlab",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyterlab/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyterlab.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "schema/*.json",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+  ],
+  "sideEffects": [
+    "style/**/*"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "directories": {
+    "lib": "lib/"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc -w --listEmittedFiles"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "^2.0.0-alpha.4",
+    "@jupyterlab/apputils": "^2.0.0-alpha.4",
+    "@lumino/coreutils": "^1.4.0",
+    "@lumino/disposable": "^1.3.2",
+    "@lumino/signaling": "^1.3.2",
+    "@lumino/widgets": "^1.9.4",
+    "react": "~16.9.0"
+  },
+  "devDependencies": {
+    "rimraf": "~3.0.0",
+    "typescript": "~3.7.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}