Add toggle toolbar button for notebook7.x

minjk-bl · minjk-bl · commit 3312d5f30f98 · 2023-10-13T18:35:48.000+09:00
diff --git a/jupyterlab/lib/VpPanel.js b/jupyterlab/lib/VpPanel.js
@@ -8,7 +8,7 @@ define([
 	'jquery-ui', 
 	'jquery-ui-css',
 	'codemirror/lib/codemirror', 
-	// __VP_CSS_LOADER__('codemirror/lib/codemirror'), // INTEGRATION: unified version of css loader 
+	'vp_base/lib/codemirror/lib/codemirror.css', // INTEGRATION: unified version of css loader 
 	'vp_base/js/loadVisualpython',
 	'vp_base/js/com/com_Config'
 ], function(
@@ -17,7 +17,7 @@ define([
 	text, css, $, 
 	ui, uiCss,
 	codemirror, 
-	// cmCss, 
+	cmCss, 
 	loadVisualpython, com_Config) {
 
 	const { 
@@ -41,9 +41,9 @@ define([
 			this.app = app;
 			this.vpFrame = loadVisualpython.initVisualpython();
 
-			this.id = 'visualpython_vpPanel';
+			this.id = 'jupyterlab-visualpython:panel';
 			// LabIcon with svg : @jupyterlab/ui-components/lib/icon/labicon.js
-			this.title.icon = new LabIcon({ name: 'visualpython:toggle', svgstr: vpIcon.default });
+			this.title.icon = new LabIcon({ name: 'jupyterlab-visualpython:toggle-icon', svgstr: vpIcon });
 			this.title.caption = 'Visual Python';
 			
 			// register node using jquery to element
diff --git a/jupyterlab/lib/index.js b/jupyterlab/lib/index.js
@@ -14,12 +14,17 @@ global.__VP_RAW_LOADER__ = function(path) {
     return path;
 }
 
+const vpId = 'jupyterlab-visualpython:plugin';
+
+const { ICommandPalette } = require('@jupyterlab/apputils');
+
 global.$ = $;
 global.vpBase = path.resolve(__dirname, "lib") + '/';
 module.exports = [{
-    id: 'visualpython:entry',
+    id: vpId,
     autoStart: true,
-    activate: function (app) {
+    requires: [ICommandPalette],
+    activate: function (app, palette) {
         console.log(
             'JupyterLab extension visualpython is activated!'
         );
@@ -35,5 +40,30 @@ module.exports = [{
         // Add vp to the right area:
         var vpPanel = new VpPanel(app);
         app.shell.add(vpPanel, 'right', { rank: 900, type: 'Visual Python' });
+
+        // Add toggle button
+        let isVpVisible = app.name !== 'JupyterLab'; // compatible for notebook 7.x (hidden for jupyterlab)
+        let toggleCommand = 'jupyterlab-visualpython:toggle-panel';
+        let vpLabel = isVpVisible?'Toggle Visual Python':'';
+        app.commands.addCommand(toggleCommand, {
+            isEnabled: () => isVpVisible,
+            isVisible: () => isVpVisible,
+            iconClass: 'jp-vp-icon',
+            iconLabel: vpLabel,
+            execute: () => {
+                if (app.shell.rightCollapsed === true || $('#vp_wrapper').is(':visible') === false) {
+                    app.shell.activateById('vp_wrapper');
+                } else {
+                    app.shell.collapseRight();
+                }
+            }
+        });
+
+        // Add command palette
+        palette.addItem({
+            command: toggleCommand,
+            category: 'Visual Python',
+            label: 'Toggle Visual Python'
+        });
     }
 }];
diff --git a/jupyterlab/schema/plugin.json b/jupyterlab/schema/plugin.json
@@ -0,0 +1,22 @@
+{
+    "jupyter.lab.toolbars": {
+        "Notebook": [
+            {
+                "name": "show-visualpython",
+                "command": "jupyterlab-visualpython:toggle-panel"
+            }
+        ]
+    },
+    "jupyter.lab.shortcuts": [
+        {
+            "command": "jupyterlab-visualpython:toggle-panel",
+            "keys": ["Accel Shift V"],
+            "selector": "body"
+        }
+    ],
+    "title": "jupyterlab-visualpython",
+    "description": "jupyterlab-visualpython plugin",
+    "type": "object",
+    "properties": {},
+    "additionalProperties": false
+}
diff --git a/jupyterlab/style/base.css b/jupyterlab/style/base.css
@@ -0,0 +1,8 @@
+.jp-vp-icon {
+    background-image: url('./icon.svg');
+}
+/* lm-mod-hidden is not on appropriate tag when isVisible is false */
+.lm-mod-hidden[data-command="jupyterlab-visualpython:toggle-panel"] {
+    display: none !important;
+    cursor: default;
+}
diff --git a/jupyterlab/visualpython/__init__.py b/jupyterlab/visualpython/__init__.py
@@ -1,16 +1,16 @@
+try:
+    from ._version import __version__
+except ImportError:
+    # Fallback when using the package in dev mode without installing
+    # in editable mode with pip. It is highly recommended to install
+    # the package from a stable release or in editable mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
+    import warnings
+    warnings.warn("Importing 'jupyterlab-visualpython' outside a proper installation.")
+    __version__ = "dev"
 
-import json
-from pathlib import Path
-
-from ._version import __version__
-
-HERE = Path(__file__).parent.resolve()
-
-with (HERE / "labextension" / "package.json").open() as fid:
-    data = json.load(fid)
 
 def _jupyter_labextension_paths():
     return [{
         "src": "labextension",
-        "dest": data["name"]
+        "dest": "jupyterlab-visualpython"
     }]
