Add hover and leave callbacks for linkprovider

Fixes #3056.
xtermjs · Jan 25, 2021 · 6982201 · 6982201
1 parent 28bcd88
commit 6982201
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/addons/xterm-addon-web-links/src/WebLinkProvider.ts b/addons/xterm-addon-web-links/src/WebLinkProvider.ts
@@ -3,20 +3,35 @@
  * @license MIT
  */
 
-import { ILinkProvider, IBufferCellPosition, ILink, Terminal } from 'xterm';
+import { ILinkProvider, IBufferCellPosition, ILink, Terminal, ILinkMatcherOptions, IViewportRange } from 'xterm';
 
 export class WebLinkProvider implements ILinkProvider {
 
   constructor(
     private readonly _terminal: Terminal,
     private readonly _regex: RegExp,
-    private readonly _handler: (event: MouseEvent, uri: string) => void
+    private readonly _handler: (event: MouseEvent, uri: string) => void,
+    private readonly _options: ILinkMatcherOptions
   ) {
 
   }
 
   public provideLinks(y: number, callback: (links: ILink[] | undefined) => void): void {
-    callback(LinkComputer.computeLink(y, this._regex, this._terminal, this._handler));
+    const links = LinkComputer.computeLink(y, this._regex, this._terminal, this._handler);
+    callback(this._addCallBacks(links, this._options.tooltipCallback, this._options.leaveCallback));
+  }
+
+  private _addCallBacks(links: ILink[], hover?: (event: MouseEvent, uri: string, location: IViewportRange) => void, leave?: (event: MouseEvent, uri: string) => void): ILink[] {
+    return links.map((link): ILink => {
+      let hoverCallback = (event: MouseEvent, uri: string): void => { };
+      if (hover) {
+        hoverCallback = (event, uri): void => {
+          const { range } = link;
+          hover(event, uri, range);
+        };
+      }
+      return { ...link, leave, hover: hoverCallback };
+    });
   }
 }
 

diff --git a/addons/xterm-addon-web-links/src/WebLinksAddon.ts b/addons/xterm-addon-web-links/src/WebLinksAddon.ts
@@ -53,7 +53,7 @@ export class WebLinksAddon implements ITerminalAddon {
     this._terminal = terminal;
 
     if (this._useLinkProvider && 'registerLinkProvider' in this._terminal) {
-      this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, strictUrlRegex, this._handler));
+      this._linkProvider = this._terminal.registerLinkProvider(new WebLinkProvider(this._terminal, strictUrlRegex, this._handler, this._options));
     } else {
       // TODO: This should be removed eventually
       this._linkMatcherId = (this._terminal as Terminal).registerLinkMatcher(strictUrlRegex, this._handler, this._options);