Move options to addon and avoid recreating options

This commit is contained in:
Daniel Imms
2021-02-03 05:28:23 -08:00
parent eec804dd7c
commit bd6676d3b6
4 changed files with 36 additions and 28 deletions
@@ -3,7 +3,12 @@
* @license MIT * @license MIT
*/ */
import { ILinkProvider, ILink, Terminal, IViewportRange, ILinkProviderOptions } from 'xterm'; import { ILinkProvider, ILink, Terminal, IViewportRange } from 'xterm';
interface ILinkProviderOptions {
hover?(event: MouseEvent, text: string, location: IViewportRange): void;
leave?(event: MouseEvent, text: string): void;
}
export class WebLinkProvider implements ILinkProvider { export class WebLinkProvider implements ILinkProvider {
@@ -3,7 +3,7 @@
* @license MIT * @license MIT
*/ */
import { Terminal, ILinkMatcherOptions, ITerminalAddon, IDisposable, ILinkProviderOptions } from 'xterm'; import { Terminal, ILinkMatcherOptions, ITerminalAddon, IDisposable, IViewportRange } from 'xterm';
import { WebLinkProvider } from './WebLinkProvider'; import { WebLinkProvider } from './WebLinkProvider';
const protocolClause = '(https?:\\/\\/)'; const protocolClause = '(https?:\\/\\/)';
@@ -36,6 +36,11 @@ function handleLink(event: MouseEvent, uri: string): void {
} }
} }
interface ILinkProviderOptions {
hover?(event: MouseEvent, text: string, location: IViewportRange): void;
leave?(event: MouseEvent, text: string): void;
}
export class WebLinksAddon implements ITerminalAddon { export class WebLinksAddon implements ITerminalAddon {
private _linkMatcherId: number | undefined; private _linkMatcherId: number | undefined;
private _terminal: Terminal | undefined; private _terminal: Terminal | undefined;
@@ -43,24 +48,22 @@ export class WebLinksAddon implements ITerminalAddon {
constructor( constructor(
private _handler: (event: MouseEvent, uri: string) => void = handleLink, private _handler: (event: MouseEvent, uri: string) => void = handleLink,
private _options: ILinkMatcherOptions = {}, private _options: ILinkMatcherOptions | ILinkProviderOptions = {},
private _useLinkProvider: boolean = false private _useLinkProvider: boolean = false
) { ) {
this._options.matchIndex = 1;
} }
public activate(terminal: Terminal): void { public activate(terminal: Terminal): void {
this._terminal = terminal; this._terminal = terminal;
if (this._useLinkProvider && 'registerLinkProvider' in this._terminal) { if (this._useLinkProvider && 'registerLinkProvider' in this._terminal) {
const options = { const options = this._options as ILinkProviderOptions;
hover: this._options.tooltipCallback,
leave: this._options.leaveCallback
};
this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, strictUrlRegex, this._handler, options)); this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, strictUrlRegex, this._handler, options));
} else { } else {
// TODO: This should be removed eventually // TODO: This should be removed eventually
this._linkMatcherId = (this._terminal as Terminal).registerLinkMatcher(strictUrlRegex, this._handler, this._options); const options = this._options as ILinkMatcherOptions;
options.matchIndex = 1;
this._linkMatcherId = (this._terminal as Terminal).registerLinkMatcher(strictUrlRegex, this._handler, options);
} }
} }
@@ -4,7 +4,7 @@
*/ */
import { Terminal, ILinkMatcherOptions, ITerminalAddon } from 'xterm'; import { Terminal, ILinkMatcherOptions, ITerminalAddon, IViewportRange } from 'xterm';
declare module 'xterm-addon-web-links' { declare module 'xterm-addon-web-links' {
/** /**
@@ -20,7 +20,7 @@ declare module 'xterm-addon-web-links' {
* link provider (new) may cause issues. Link provider will eventually be * link provider (new) may cause issues. Link provider will eventually be
* the default and only option. * the default and only option.
*/ */
constructor(handler?: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions, useLinkProvider?: boolean); constructor(handler?: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions | ILinkProviderOptions, useLinkProvider?: boolean);
/** /**
* Activates the addon * Activates the addon
@@ -33,4 +33,21 @@ declare module 'xterm-addon-web-links' {
*/ */
public dispose(): void; public dispose(): void;
} }
/**
* An object containing options for a link provider.
*/
export interface ILinkProviderOptions {
/**
* A callback that fires when the mouse hovers over a link for a period of
* time (defined by {@link ITerminalOptions.linkTooltipHoverDuration}).
*/
hover?(event: MouseEvent, text: string, location: IViewportRange): void;
/**
* A callback that fires when the mouse leaves a link. Note that this can
* happen even when tooltipCallback hasn't fired for the link yet.
*/
leave?(event: MouseEvent, text: string): void;
}
} }
-17
View File
@@ -352,23 +352,6 @@ declare module 'xterm' {
willLinkActivate?: (event: MouseEvent, uri: string) => boolean; willLinkActivate?: (event: MouseEvent, uri: string) => boolean;
} }
/**
* An object containing options for a link provider.
*/
export interface ILinkProviderOptions {
/**
* A callback that fires when the mouse hovers over a link for a period of
* time (defined by {@link ITerminalOptions.linkTooltipHoverDuration}).
*/
hover?(event: MouseEvent, text: string, location: IViewportRange): void;
/**
* A callback that fires when the mouse leaves a link. Note that this can
* happen even when tooltipCallback hasn't fired for the link yet.
*/
leave?(event: MouseEvent, text: string): void;
}
/** /**
* An object that can be disposed via a dispose function. * An object that can be disposed via a dispose function.
*/ */