Remove deprecated add* APIs

Fixes #2652
This commit is contained in:
Daniel Imms
2022-07-27 08:35:40 -07:00
parent 140073675c
commit 8cfa7a0ee2
4 changed files with 13 additions and 27 deletions
+9 -9
View File
@@ -736,7 +736,7 @@ function powerlineSymbolTest() {
function addDecoration() { function addDecoration() {
term.options['overviewRulerWidth'] = 15; term.options['overviewRulerWidth'] = 15;
const marker = term.addMarker(1); const marker = term.registerMarker(1);
const decoration = term.registerDecoration({ const decoration = term.registerDecoration({
marker, marker,
backgroundColor: '#00FF00', backgroundColor: '#00FF00',
@@ -751,13 +751,13 @@ function addDecoration() {
function addOverviewRuler() { function addOverviewRuler() {
term.options['overviewRulerWidth'] = 15; term.options['overviewRulerWidth'] = 15;
term.registerDecoration({marker: term.addMarker(1), overviewRulerOptions: { color: '#ef2929' }}); term.registerDecoration({marker: term.registerMarker(1), overviewRulerOptions: { color: '#ef2929' }});
term.registerDecoration({marker: term.addMarker(3), overviewRulerOptions: { color: '#8ae234' }}); term.registerDecoration({marker: term.registerMarker(3), overviewRulerOptions: { color: '#8ae234' }});
term.registerDecoration({marker: term.addMarker(5), overviewRulerOptions: { color: '#729fcf' }}); term.registerDecoration({marker: term.registerMarker(5), overviewRulerOptions: { color: '#729fcf' }});
term.registerDecoration({marker: term.addMarker(7), overviewRulerOptions: { color: '#ef2929', position: 'left' }}); term.registerDecoration({marker: term.registerMarker(7), overviewRulerOptions: { color: '#ef2929', position: 'left' }});
term.registerDecoration({marker: term.addMarker(7), overviewRulerOptions: { color: '#8ae234', position: 'center' }}); term.registerDecoration({marker: term.registerMarker(7), overviewRulerOptions: { color: '#8ae234', position: 'center' }});
term.registerDecoration({marker: term.addMarker(7), overviewRulerOptions: { color: '#729fcf', position: 'right' }}); term.registerDecoration({marker: term.registerMarker(7), overviewRulerOptions: { color: '#729fcf', position: 'right' }});
term.registerDecoration({marker: term.addMarker(10), overviewRulerOptions: { color: '#8ae234', position: 'center' }}); term.registerDecoration({marker: term.registerMarker(10), overviewRulerOptions: { color: '#8ae234', position: 'center' }});
term.registerDecoration({marker: term.addMarker(10), overviewRulerOptions: { color: '#ffffff80', position: 'full' }}); term.registerDecoration({marker: term.registerMarker(10), overviewRulerOptions: { color: '#ffffff80', position: 'full' }});
} }
-4
View File
@@ -160,7 +160,6 @@ export class Terminal implements ITerminalApi {
this._core.deregisterCharacterJoiner(joinerId); this._core.deregisterCharacterJoiner(joinerId);
} }
public registerMarker(cursorYOffset: number = 0): IMarker | undefined { public registerMarker(cursorYOffset: number = 0): IMarker | undefined {
this._checkProposedApi();
this._verifyIntegers(cursorYOffset); this._verifyIntegers(cursorYOffset);
return this._core.addMarker(cursorYOffset); return this._core.addMarker(cursorYOffset);
} }
@@ -169,9 +168,6 @@ export class Terminal implements ITerminalApi {
this._verifyPositiveIntegers(decorationOptions.x ?? 0, decorationOptions.width ?? 0, decorationOptions.height ?? 0); this._verifyPositiveIntegers(decorationOptions.x ?? 0, decorationOptions.width ?? 0, decorationOptions.height ?? 0);
return this._core.registerDecoration(decorationOptions); return this._core.registerDecoration(decorationOptions);
} }
public addMarker(cursorYOffset: number): IMarker | undefined {
return this.registerMarker(cursorYOffset);
}
public hasSelection(): boolean { public hasSelection(): boolean {
return this._core.hasSelection(); return this._core.hasSelection();
} }
+2 -7
View File
@@ -630,18 +630,13 @@ declare module 'xterm-headless' {
resize(columns: number, rows: number): void; resize(columns: number, rows: number): void;
/** /**
* (EXPERIMENTAL) Adds a marker to the normal buffer and returns it. If the * Adds a marker to the normal buffer and returns it. If the alt buffer is
* alt buffer is active, undefined is returned. * active, undefined is returned.
* @param cursorYOffset The y position offset of the marker from the cursor. * @param cursorYOffset The y position offset of the marker from the cursor.
* @returns The new marker or undefined. * @returns The new marker or undefined.
*/ */
registerMarker(cursorYOffset?: number): IMarker | undefined; registerMarker(cursorYOffset?: number): IMarker | undefined;
/**
* @deprecated use `registerMarker` instead.
*/
addMarker(cursorYOffset: number): IMarker | undefined;
/* /*
* Disposes of the terminal, detaching it from the DOM and removing any * Disposes of the terminal, detaching it from the DOM and removing any
* active listeners. * active listeners.
+2 -7
View File
@@ -912,18 +912,13 @@ declare module 'xterm' {
deregisterCharacterJoiner(joinerId: number): void; deregisterCharacterJoiner(joinerId: number): void;
/** /**
* (EXPERIMENTAL) Adds a marker to the normal buffer and returns it. If the * Adds a marker to the normal buffer and returns it. If the alt buffer is
* alt buffer is active, undefined is returned. * active, undefined is returned.
* @param cursorYOffset The y position offset of the marker from the cursor. * @param cursorYOffset The y position offset of the marker from the cursor.
* @returns The new marker or undefined. * @returns The new marker or undefined.
*/ */
registerMarker(cursorYOffset?: number): IMarker | undefined; registerMarker(cursorYOffset?: number): IMarker | undefined;
/**
* @deprecated use `registerMarker` instead.
*/
addMarker(cursorYOffset: number): IMarker | undefined;
/** /**
* (EXPERIMENTAL) Adds a decoration to the terminal using * (EXPERIMENTAL) Adds a decoration to the terminal using
* @param decorationOptions, which takes a marker and an optional anchor, * @param decorationOptions, which takes a marker and an optional anchor,