Merge pull request #4289 from JasonXJ/scroll-options

Add option scrollOnUserInput

Author: Tyriar

src/browser/Terminal.ts

@@ -995,7 +995,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
     const shouldIgnoreComposition = this.browser.isMac && this.options.macOptionIsMeta && event.altKey;
 
     if (!shouldIgnoreComposition && !this._compositionHelper!.keydown(event)) {
-      if (this.buffer.ybase !== this.buffer.ydisp) {
+      if (this.options.scrollOnUserInput && this.buffer.ybase !== this.buffer.ydisp) {
         this._bufferService.scrollToBottom();
       }
       return false;

src/common/services/CoreService.ts

@@ -68,7 +68,7 @@ export class CoreService extends Disposable implements ICoreService {
 
     // Input is being sent to the terminal, the terminal should focus the prompt.
     const buffer = this._bufferService.buffer;
-    if (buffer.ybase !== buffer.ydisp) {
+    if (wasUserInput && this._optionsService.rawOptions.scrollOnUserInput && buffer.ybase !== buffer.ydisp) {
       this._scrollToBottom!();
     }
 

src/common/services/OptionsService.ts

@@ -28,6 +28,7 @@ export const DEFAULT_OPTIONS: Readonly<Required<ITerminalOptions>> = {
   linkHandler: null,
   logLevel: 'info',
   scrollback: 1000,
+  scrollOnUserInput: true,
   scrollSensitivity: 1,
   screenReaderMode: false,
   smoothScrollDuration: 0,

src/common/services/Services.ts

@@ -85,9 +85,9 @@ export interface ICoreService {
   /**
    * Triggers the onData event in the public API.
    * @param data The data that is being emitted.
-   * @param wasFromUser Whether the data originated from the user (as opposed to
+   * @param wasUserInput Whether the data originated from the user (as opposed to
    * resulting from parsing incoming data). When true this will also:
-   * - Scroll to the bottom of the buffer.s
+   * - Scroll to the bottom of the buffer if option scrollOnUserInput is true.
    * - Fire the `onUserInput` event (so selection can be cleared).
    */
   triggerDataEvent(data: string, wasUserInput?: boolean): void;
@@ -243,6 +243,7 @@ export interface ITerminalOptions {
   rows?: number;
   screenReaderMode?: boolean;
   scrollback?: number;
+  scrollOnUserInput?: boolean;
   scrollSensitivity?: number;
   smoothScrollDuration?: number;
   tabStopWidth?: number;

typings/xterm.d.ts

@@ -193,6 +193,12 @@ declare module 'xterm' {
      */
     scrollback?: number;
 
+    /**
+     * Whether to scroll to the bottom whenever there is some user input. The
+     * default is true.
+     */
+    scrollOnUserInput?: boolean;
+
     /**
      * The scrolling speed multiplier used for adjusting normal scrolling speed.
      */