Add duration-based smooth scroll

Fixes #1140
2022-07-27 05:41:00 -07:00
parent b11217aa36
commit a55728dd28
5 changed files with 65 additions and 2 deletions
@@ -182,10 +182,17 @@ declare module 'xterm-headless' {
    scrollback?: number;

    /**
-     * The scrolling speed multiplier used for adjusting normal scrolling speed.
+     * The duration to smoothly scroll between the origin and the target in
+     * milliseconds. Set to 0 to disable smooth scrolling and scroll instantly.
     */
    scrollSensitivity?: number;

+    /**
+     * The duration to smoothly scroll between the origin and the target. Set
+     * this to 0 to disable smooth scrolling and scroll instantly.
+     */
+     smoothScrollingDuration?: number;
+
    /**
     * The size of tab stops in the terminal.
     */
@@ -233,6 +233,12 @@ declare module 'xterm' {
     */
    scrollSensitivity?: number;

+    /**
+     * The duration to smoothly scroll between the origin and the target in
+     * milliseconds. Set to 0 to disable smooth scrolling and scroll instantly.
+     */
+    smoothScrollingDuration?: number;
+
    /**
     * The size of tab stops in the terminal.
     */