don't show toggle button when not in notebook/lab

spacetelescope · Aug 7, 2024 · 8ae0c5b · 8ae0c5b
1 parent 96c5cf1
commit 8ae0c5b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/docs/plugin_api.rst b/docs/plugin_api.rst
@@ -14,4 +14,4 @@ For example:
   plugin.open_in_tray()
   plugin.show('popout')
 
-Some plugins provide API hints directly in the UI.  To enable these, toggle the ``<>`` button in the top of the plugin.
+When running in a notebook, some plugins provide API hints directly in the UI.  To enable these, toggle the ``<>`` button in the top of the plugin.
diff --git a/jdaviz/components/tray_plugin.vue b/jdaviz/components/tray_plugin.vue
@@ -9,7 +9,8 @@
       <div style="width: 32px">
         <j-tooltip tipid='plugin-api-hints'>
           <v-btn
-            v-if="api_hints_enabled !== undefined && config && plugin_key" 
+            v-if="api_hints_enabled !== undefined && config && plugin_key && checkNotebookContext()" 
+            id="api-hints-button"
             icon 
             :class="api_hints_enabled ? 'api-hint' : null"
             @click="() => {$emit('update:api_hints_enabled', !api_hints_enabled)}"
@@ -87,7 +88,14 @@ module.exports = {
       setTimeout(() => {
         this.sendPing(true)          
       }, 200)  // ms
-    }
+    },
+    checkNotebookContext() {
+      // copied from app.vue
+      this.notebook_context = document.getElementById("ipython-main-app")
+        || document.querySelector('.jp-LabShell')
+        || document.querySelector(".lm-Widget#main"); /* Notebook 7 */
+      return false && this.notebook_context;
+    },
   },
   mounted() {
     this.sendPing(true);