Hide gallery without exhibits

jupyterlab_gallery/handlers.py

@@ -27,6 +27,7 @@ def get(self):
                 {
                     "title": self.gallery_manager.title,
                     "exhibitsConfigured": len(self.gallery_manager.exhibits) != 0,
+                    "hideGalleryWithoutExhibits": self.gallery_manager.hideGalleryWithoutExhibits,
                     "apiVersion": "1.0",
                 }
             )

jupyterlab_gallery/manager.py

@@ -5,7 +5,7 @@
 from threading import Thread
 
 from traitlets.config.configurable import LoggingConfigurable
-from traitlets import Dict, List, Unicode
+from traitlets import Dict, List, Unicode, Bool
 
 from .git_utils import (
     extract_repository_owner,
@@ -69,6 +69,12 @@ def __init__(self, *args, **kwargs):
         config=True,
     )
 
+    hideGalleryWithoutExhibits = Bool(
+        help="Hide Gallery if no exhibits are configured",
+        default_value=False,
+        config=True
+    )
+
     def get_local_path(self, exhibit) -> Path:
         clone_destination = Path(self.destination)
         repository_name = extract_repository_name(exhibit["git"])

src/index.ts

@@ -61,10 +61,17 @@ const plugin: JupyterFrontEndPlugin<void> = {
         `jupyter-gallery API version out of sync, expected ${expectedVersion}, got ${data.apiVersion}`
       );
     }
-
     const title = data.title === 'Gallery' ? trans.__('Gallery') : data.title;
+
+    // hide the widget if no exhibits are configured
+    if (data.hideGalleryWithoutExhibits && !data.exhibitsConfigured) {
+      console.log(
+        'Gallery extension will not add any UI elements because no exhibits are configured'
+      );
+      return;
+    }
     // add the widget to sidebar before waiting for server reply to reduce UI jitter
-    if (launcher && isNewLauncher(launcher) && data.exhibitsConfigured) {
+    if (launcher && isNewLauncher(launcher)) {
       launcher.addSection({
         title,
         className: 'jp-Launcher-openExample',

src/types.ts

@@ -2,6 +2,7 @@ export interface IGalleryReply {
   title: string;
   apiVersion: string;
   exhibitsConfigured: boolean;
+  hideGalleryWithoutExhibits: boolean;
 }
 
 export interface IExhibitReply {