Fix top bar visibility not picking up settings overrides (#6833)

* The header part reflects both user preference and default settings overrides. * Toggle 'Show Header' turns off the automatic adjustment.
jupyter · May 2, 2023 · 6604839 · 6604839
1 parent 7c3c992
commit 6604839
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 5 deletions.
diff --git a/packages/application-extension/schema/top.json b/packages/application-extension/schema/top.json
@@ -22,6 +22,12 @@
       "title": "Top Bar Visibility",
       "description": "Whether to show the top bar or not",
       "default": true
+    },
+    "adjustToScreen": {
+      "type": "boolean",
+      "title": "Automatic Top Bar Visibility",
+      "description": "Whether to automatically adjust top bar visibility according to screen size, overriding above visible setting",
+      "default": true
     }
   },
   "additionalProperties": false,

diff --git a/packages/application-extension/src/index.ts b/packages/application-extension/src/index.ts
@@ -483,20 +483,31 @@ const topVisibility: JupyterFrontEndPlugin<void> = {
         top.setHidden(top.isVisible);
         if (settingRegistry) {
           void settingRegistry.set(pluginId, 'visible', top.isVisible);
+          // turn off 'adjustToScreen' if user manually toggle 'Show Header'
+          void settingRegistry.set(pluginId, 'adjustToScreen', false);
         }
       },
       isToggled: () => top.isVisible,
     });
 
-    let settingsOverride = false;
+    let noAdjust = false;
 
     if (settingRegistry) {
       const loadSettings = settingRegistry.load(pluginId);
       const updateSettings = (settings: ISettingRegistry.ISettings): void => {
-        const visible = settings.get('visible').composite;
+        // 'visible' property from user preferences or default settings
+        let visible = settings.get('visible').composite;
         if (settings.user.visible !== undefined) {
-          settingsOverride = true;
-          top.setHidden(!visible);
+          visible = settings.user.visible;
+        }
+        top.setHidden(!visible);
+        // 'adjustToScreen' property from user preferences or default settings
+        let adjustToScreen = settings.get('adjustToScreen').composite;
+        if (settings.user.adjustToScreen !== undefined) {
+          adjustToScreen = settings.user.adjustToScreen;
+        }
+        if (!adjustToScreen) {
+          noAdjust = true;
         }
       };
 
@@ -517,7 +528,7 @@ const topVisibility: JupyterFrontEndPlugin<void> = {
     }
 
     const onChanged = (): void => {
-      if (settingsOverride) {
+      if (noAdjust) {
         return;
       }
       if (app.format === 'desktop') {