Merge pull request #798 from jupyterlab/show-toc-in-zen-mode

show TOC in Zen mode option

Author: mbektas

src/main/app.ts

@@ -414,7 +414,8 @@ export class JupyterApplication implements IApplication, IDisposable {
         uiMode: userSettings.getValue(SettingType.uiMode),
         uiModeForSingleFileOpen: userSettings.getValue(
           SettingType.uiModeForSingleFileOpen
-        )
+        ),
+        showTOCInZenMode: userSettings.getValue(SettingType.showTOCInZenMode)
       },
       this._registry
     );

src/main/config/settings.ts

@@ -72,7 +72,8 @@ export enum SettingType {
   condaChannels = 'condaChannels',
 
   uiMode = 'uiMode',
-  uiModeForSingleFileOpen = 'uiModeForSingleFileOpen'
+  uiModeForSingleFileOpen = 'uiModeForSingleFileOpen',
+  showTOCInZenMode = 'showTOCInZenMode'
 }
 
 export const serverLaunchArgsFixed = [
@@ -174,7 +175,8 @@ export class UserSettings {
       uiMode: new Setting<UIMode>(UIMode.ManagedByWebApp, {
         wsOverridable: true
       }),
-      uiModeForSingleFileOpen: new Setting<UIMode>(UIMode.Zen)
+      uiModeForSingleFileOpen: new Setting<UIMode>(UIMode.Zen),
+      showTOCInZenMode: new Setting<boolean>(false)
     };
 
     if (readSettings) {

src/main/labview/labview.ts

@@ -282,7 +282,9 @@ export class LabView implements IDisposable {
 
     await this._view.webContents.executeJavaScript(`
     {
-      jlabDesktop_setUIMode('${this._uiMode}');
+      jlabDesktop_setUIMode('${this._uiMode}', {
+        showTOCInZenMode: ${userSettings.getValue(SettingType.showTOCInZenMode)}
+      });
     }
   `);
   }
@@ -463,7 +465,7 @@ export class LabView implements IDisposable {
           });
         }
 
-        async function jlabDesktop_setUIMode(uiMode) {
+        async function jlabDesktop_setUIMode(uiMode, options) {
           const lab = await jlabDesktop_getLab();
           const labShell = lab.shell;
           const statusBar = labShell.widgets('bottom').find(widget => widget.id === 'jp-main-statusbar');
@@ -518,15 +520,23 @@ export class LabView implements IDisposable {
                 statusBar.setHidden(true);
               }
             }
+            if (options?.showTOCInZenMode) {
+              labShell.activateById('table-of-contents');
+            }
           }
         }
 
         jlabDesktop_getLab().then((lab) => {
           ${
             setToSingleFileUIMode
-              ? `jlabDesktop_setUIMode('${userSettings.getValue(
-                  SettingType.uiModeForSingleFileOpen
-                )}');`
+              ? `jlabDesktop_setUIMode(
+                  '${userSettings.getValue(
+                    SettingType.uiModeForSingleFileOpen
+                  )}', {
+                    showTOCInZenMode: ${userSettings.getValue(
+                      SettingType.showTOCInZenMode
+                    )}
+                  });`
               : ''
           }
           lab.restored.then(() => {

src/main/settingsdialog/settingsdialog.ts

@@ -44,7 +44,8 @@ export class SettingsDialog {
       serverEnvVars,
       ctrlWBehavior,
       uiMode,
-      uiModeForSingleFileOpen
+      uiModeForSingleFileOpen,
+      showTOCInZenMode
     } = options;
     const installUpdatesAutomaticallyEnabled = process.platform === 'darwin';
     const installUpdatesAutomatically =
@@ -195,6 +196,10 @@ export class SettingsDialog {
                     </div>
                   </div>
                 </div>
+                
+                <div class="row">
+                  <jp-checkbox id='checkbox-show-toc-in-zen-mode' type='checkbox' <%= showTOCInZenMode ? 'checked' : '' %>>Show Table of Contents in Zen Mode</jp-checkbox>
+                </div>
               </div>
               
               <jp-radio-group orientation="horizontal">
@@ -519,6 +524,7 @@ export class SettingsDialog {
             updateBundledEnvAutomatically: updateBundledEnvAutomaticallyCheckbox.checked,
             uiMode: document.getElementById('ui-mode').value,
             uiModeForSingleFileOpen: document.getElementById('ui-mode-for-single-file-open').value,
+            showTOCInZenMode: document.getElementById('checkbox-show-toc-in-zen-mode').checked
           });
 
           window.electronAPI.setDefaultWorkingDirectory(workingDirectoryInput.value);
@@ -562,7 +568,8 @@ export class SettingsDialog {
       ctrlWBehavior,
       cliCommandIsSetup,
       uiMode,
-      uiModeForSingleFileOpen
+      uiModeForSingleFileOpen,
+      showTOCInZenMode
     });
   }
 
@@ -604,5 +611,6 @@ export namespace SettingsDialog {
     ctrlWBehavior: CtrlWBehavior;
     uiMode: UIMode;
     uiModeForSingleFileOpen: UIMode;
+    showTOCInZenMode: boolean;
   }
 }