editor: add toggle sticky scroll command (#11926)

The commit adds support for the `toggle sticky scroll` command and menu in the framework in order to toggle sticky scroll in monaco editors.
eclipse-theia · Dec 9, 2022 · 1446bca · 1446bca
1 parent 4440abd
commit 1446bca
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/packages/editor/src/browser/editor-command.ts b/packages/editor/src/browser/editor-command.ts
@@ -150,6 +150,14 @@ export namespace EditorCommands {
         category: CommonCommands.VIEW_CATEGORY,
         label: 'Toggle Word Wrap'
     });
+    /**
+     * Command that toggles sticky scroll.
+     */
+    export const TOGGLE_STICKY_SCROLL = Command.toLocalizedCommand({
+        id: 'editor.action.toggleStickyScroll',
+        category: CommonCommands.VIEW_CATEGORY,
+        label: 'Toggle Sticky Scroll',
+    }, 'theia/editor/toggleStickyScroll', EDITOR_CATEGORY_KEY);
     /**
      * Command that re-opens the last closed editor.
      */
@@ -265,6 +273,7 @@ export class EditorCommandContribution implements CommandContribution {
         registry.registerCommand(EditorCommands.TOGGLE_MINIMAP);
         registry.registerCommand(EditorCommands.TOGGLE_RENDER_WHITESPACE);
         registry.registerCommand(EditorCommands.TOGGLE_WORD_WRAP);
+        registry.registerCommand(EditorCommands.TOGGLE_STICKY_SCROLL);
         registry.registerCommand(EditorCommands.REOPEN_CLOSED_EDITOR);
 
         registry.registerCommand(CommonCommands.AUTO_SAVE, {

diff --git a/packages/editor/src/browser/editor-menu.ts b/packages/editor/src/browser/editor-menu.ts
@@ -173,6 +173,10 @@ export class EditorMenuContribution implements MenuContribution {
             commandId: EditorCommands.TOGGLE_RENDER_WHITESPACE.id,
             order: '3'
         });
+        registry.registerMenuAction(CommonMenus.VIEW_TOGGLE, {
+            commandId: EditorCommands.TOGGLE_STICKY_SCROLL.id,
+            order: '4'
+        });
         registry.registerMenuAction(CommonMenus.FILE_CLOSE, {
             commandId: CommonCommands.CLOSE_MAIN_TAB.id,
             label: nls.localizeByDefault('Close Editor'),

diff --git a/packages/editor/src/browser/editor-navigation-contribution.ts b/packages/editor/src/browser/editor-navigation-contribution.ts
@@ -100,6 +100,11 @@ export class EditorNavigationContribution implements Disposable, FrontendApplica
             execute: () => this.toggleWordWrap(),
             isEnabled: () => true,
         });
+        this.commandRegistry.registerHandler(EditorCommands.TOGGLE_STICKY_SCROLL.id, {
+            execute: () => this.toggleStickyScroll(),
+            isEnabled: () => true,
+            isToggled: () => this.isStickyScrollEnabled()
+        });
         this.commandRegistry.registerHandler(EditorCommands.REOPEN_CLOSED_EDITOR.id, {
             execute: () => this.reopenLastClosedEditor()
         });
@@ -188,6 +193,14 @@ export class EditorNavigationContribution implements Disposable, FrontendApplica
         }
     }
 
+    /**
+     * Toggle the display of sticky scroll in the editor.
+     */
+    protected async toggleStickyScroll(): Promise<void> {
+        const value: boolean | undefined = this.preferenceService.get('editor.stickyScroll.enabled');
+        this.preferenceService.set('editor.stickyScroll.enabled', !value, PreferenceScope.User);
+    }
+
     /**
      * Toggle the display of minimap in the editor.
      */
@@ -312,4 +325,7 @@ export class EditorNavigationContribution implements Disposable, FrontendApplica
         return !!this.preferenceService.get(EditorNavigationContribution.MOUSE_NAVIGATION_PREFERENCE);
     }
 
+    private isStickyScrollEnabled(): boolean {
+        return !!this.preferenceService.get('editor.stickyScroll.enabled');
+    }
 }