Add terminal scroll commands.

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>
eclipse-theia · Feb 26, 2020 · 46ad80f · 46ad80f
1 parent 02d6964
commit 46ad80f
Show file tree

Hide file tree

Showing 4 changed files with 119 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,7 @@
 Breaking changes:
 
 - [core] fixed typo (highligh -> highlight) in caption highlight fragment [#7050](https://github.com/eclipse-theia/theia/pull/7050)
+- [terminal] added new abstract methods to the TerminalWidget[#7179]: `scrollLineUp`, `scrollLineDown`, `scrollToTop`, `scrollPageUp`, `scrollPageDown`
 
 ## v0.15.0
 

diff --git a/packages/terminal/src/browser/base/terminal-widget.ts b/packages/terminal/src/browser/base/terminal-widget.ts
@@ -39,6 +39,16 @@ export abstract class TerminalWidget extends BaseWidget {
 
     abstract onDidOpen: Event<void>;
 
+    abstract scrollLineUp(): void;
+
+    abstract scrollLineDown(): void;
+
+    abstract scrollToTop(): void;
+
+    abstract scrollPageUp(): void;
+
+    abstract scrollPageDown(): void;
+
     /**
      * Event which fires when terminal did closed. Event value contains closed terminal widget definition.
      */

diff --git a/packages/terminal/src/browser/terminal-frontend-contribution.ts b/packages/terminal/src/browser/terminal-frontend-contribution.ts
@@ -93,6 +93,33 @@ export namespace TerminalCommands {
         category: TERMINAL_CATEGORY,
         label: 'Hide find widget'
     };
+
+    export const SCROLL_LINE_UP: Command = {
+        id: 'terminal:scroll:line:up',
+        category: TERMINAL_CATEGORY,
+        label: 'Scroll line up'
+    };
+    export const SCROLL_LINE_DOWN: Command = {
+        id: 'terminal:scroll:line:down',
+        category: TERMINAL_CATEGORY,
+        label: 'Scroll line down'
+    };
+    export const SCROLL_TO_TOP: Command = {
+        id: 'terminal:scroll:top',
+        category: TERMINAL_CATEGORY,
+        label: 'Scroll to top'
+    };
+    export const SCROLL_PAGE_UP: Command = {
+        id: 'terminal:scroll:page:up',
+        category: TERMINAL_CATEGORY,
+        label: 'Scroll page up'
+    };
+    export const SCROLL_PAGE_DOWN: Command = {
+        id: 'terminal:scroll:page:down',
+        category: TERMINAL_CATEGORY,
+        label: 'Scroll page down'
+    };
+
     /**
      * Command that displays all terminals that are currently opened
      */
@@ -244,6 +271,42 @@ export class TerminalFrontendContribution implements TerminalService, CommandCon
                 terminalSearchBox.hide();
             }
         });
+
+        commands.registerCommand(TerminalCommands.SCROLL_LINE_UP, {
+                isEnabled: () => this.shell.activeWidget instanceof TerminalWidget,
+                isVisible: () => false,
+                execute: () => {
+                    (this.shell.activeWidget as TerminalWidget).scrollLineUp();
+                }
+        });
+        commands.registerCommand(TerminalCommands.SCROLL_LINE_DOWN, {
+            isEnabled: () => this.shell.activeWidget instanceof TerminalWidget,
+            isVisible: () => false,
+            execute: () => {
+                (this.shell.activeWidget as TerminalWidget).scrollLineDown();
+            }
+        });
+        commands.registerCommand(TerminalCommands.SCROLL_TO_TOP, {
+            isEnabled: () => this.shell.activeWidget instanceof TerminalWidget,
+            isVisible: () => false,
+            execute: () => {
+                (this.shell.activeWidget as TerminalWidget).scrollToTop();
+            }
+        });
+        commands.registerCommand(TerminalCommands.SCROLL_PAGE_UP, {
+            isEnabled: () => this.shell.activeWidget instanceof TerminalWidget,
+            isVisible: () => false,
+            execute: () => {
+                (this.shell.activeWidget as TerminalWidget).scrollPageUp();
+            }
+        });
+        commands.registerCommand(TerminalCommands.SCROLL_PAGE_DOWN, {
+            isEnabled: () => this.shell.activeWidget instanceof TerminalWidget,
+            isVisible: () => false,
+            execute: () => {
+                (this.shell.activeWidget as TerminalWidget).scrollPageDown();
+            }
+        });
     }
 
     registerMenus(menus: MenuModelRegistry): void {
@@ -291,12 +354,36 @@ export class TerminalFrontendContribution implements TerminalService, CommandCon
             keybinding: 'ctrlcmd+f',
             context: TerminalKeybindingContexts.terminalActive
         });
-
         keybindings.registerKeybinding({
             command: TerminalCommands.TERMINAL_FIND_TEXT_CANCEL.id,
             keybinding: 'esc',
             context: TerminalKeybindingContexts.terminalHideSearch
         });
+        keybindings.registerKeybinding({
+            command: TerminalCommands.SCROLL_LINE_UP.id,
+            keybinding: 'ctrl+shift+up',
+            context: TerminalKeybindingContexts.terminalActive
+        });
+        keybindings.registerKeybinding({
+            command: TerminalCommands.SCROLL_LINE_DOWN.id,
+            keybinding: 'ctrl+shift+down',
+            context: TerminalKeybindingContexts.terminalActive
+        });
+        keybindings.registerKeybinding({
+            command: TerminalCommands.SCROLL_TO_TOP.id,
+            keybinding: 'home',
+            context: TerminalKeybindingContexts.terminalActive
+        });
+        keybindings.registerKeybinding({
+            command: TerminalCommands.SCROLL_PAGE_UP.id,
+            keybinding: 'pageUp',
+            context: TerminalKeybindingContexts.terminalActive
+        });
+        keybindings.registerKeybinding({
+            command: TerminalCommands.SCROLL_PAGE_DOWN.id,
+            keybinding: 'pageDown',
+            context: TerminalKeybindingContexts.terminalActive
+        });
 
         /* Register passthrough keybindings for combinations recognized by
            xterm.js and converted to control characters.

diff --git a/packages/terminal/src/browser/terminal-widget-impl.ts b/packages/terminal/src/browser/terminal-widget-impl.ts
@@ -453,6 +453,26 @@ export class TerminalWidgetImpl extends TerminalWidget implements StatefulWidget
         }
     }
 
+    scrollLineUp(): void {
+        this.term.scrollLines(-1);
+    }
+
+    scrollLineDown(): void {
+        this.term.scrollLines(1);
+    }
+
+    scrollToTop(): void {
+        this.term.scrollToTop();
+    }
+
+    scrollPageUp(): void {
+        this.term.scrollPages(-1);
+    }
+
+    scrollPageDown(): void {
+        this.term.scrollPages(1);
+    }
+
     get onTerminalDidClose(): Event<TerminalWidget> {
         return this.onTermDidClose.event;
     }