Deprecate fast scroll modifier as it's no longer possible

Not possible via the component we import. We could add this but I
doubt it was being used anyway.
This commit is contained in:
Daniel Imms
2024-07-10 08:30:32 -07:00
parent d1d25a5bf7
commit 2b8ccb5e51
5 changed files with 9 additions and 4 deletions
+3 -2
View File
@@ -437,12 +437,13 @@ function initOptions(term: Terminal): void {
'logger',
'theme',
'windowOptions',
'windowsPty'
'windowsPty',
// Deprecated
'fastScrollModifier'
];
const stringOptions = {
cursorStyle: ['block', 'underline', 'bar'],
cursorInactiveStyle: ['outline', 'block', 'bar', 'underline', 'none'],
fastScrollModifier: ['none', 'alt', 'ctrl', 'shift'],
fontFamily: null,
fontWeight: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
fontWeightBold: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
-1
View File
@@ -41,7 +41,6 @@ export class Viewport extends Disposable {
super();
// TODO: Support smooth scroll
// TODO: Support fastScrollModifier?
this._scrollableElement = this.register(new DomScrollableElement(screenElement, {
vertical: ScrollbarVisibility.Auto,
+1
View File
@@ -219,6 +219,7 @@ export interface ITerminalOptions {
disableStdin?: boolean;
documentOverride?: any | null;
drawBoldTextInBrightColors?: boolean;
/** @deprecated No longer supported */
fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
fastScrollSensitivity?: number;
fontSize?: number;
+2
View File
@@ -83,6 +83,8 @@ declare module '@xterm/headless' {
/**
* The modifier key hold to multiply scroll speed.
* @deprecated This option is no longer available and will always use alt. Setting this will be
* ignored.
*/
fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
+3 -1
View File
@@ -109,11 +109,13 @@ declare module '@xterm/xterm' {
/**
* The modifier key hold to multiply scroll speed.
* @deprecated This option is no longer available and will always use alt. Setting this will be
* ignored.
*/
fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
/**
* The scroll speed multiplier used for fast scrolling.
* The scroll speed multiplier used for fast scrolling when `Alt` is held.
*/
fastScrollSensitivity?: number;