waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add link matcher APIs

Browse Source
This commit is contained in:
Daniel Imms
2017-08-19 09:25:57 -07:00
parent cd29c83a64
commit 4474f29ebf
2 changed files with 42 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Terminal.ts
+2 -2
View File
@@ -1397,10 +1397,10 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
* this searches the textContent of the rows. You will want to use \s to match
* a space ' ' character for example.
* @param handler The callback when the link is called.
* @param [options] Options for the link matcher.
* @param options Options for the link matcher.
* @return The ID of the new matcher, this can be used to deregister.
*/
public registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler, options: ILinkMatcherOptions): number {
public registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler, options?: ILinkMatcherOptions): number {
if (this.linkifier) {
const matcherId = this.linkifier.registerLinkMatcher(regex, handler, options);
this.refresh(0, this.rows - 1);
typings/xterm.d.ts
Vendored
+40 -16
View File
@@ -48,6 +48,30 @@ interface ITerminalOptions {
tabStopWidth?: number;
}
/**
* An object containing options for a link matcher.
*/
interface ILinkMatcherOptions {
/**
* The index of the link from the regex.match(text) call. This defaults to 0
* (for regular expressions without capture groups).
*/
matchIndex?: number;
/**
* A callback that validates an individual link, returning true if valid and
* false if invalid.
*/
validationCallback?: (uri: string, element: HTMLElement, callback: (isValid: boolean) => void) => void;
/**
* The priority of the link matcher, this defines the order in which the link
* matcher is evaluated relative to others, from highest to lowest. The
* default value is 0.
*/
priority?: number;
}
declare module 'xterm' {
/**
* The class that represents an xterm.js terminal.
@@ -159,23 +183,23 @@ declare module 'xterm' {
*/
attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) => boolean);
// /**
// * Registers a link matcher, allowing custom link patterns to be matched and
// * handled.
// * @param {RegExp} regex The regular expression to search for, specifically
// * this searches the textContent of the rows. You will want to use \s to match
// * a space ' ' character for example.
// * @param {LinkMatcherHandler} handler The callback when the link is called.
// * @param {LinkMatcherOptions} [options] Options for the link matcher.
// * @return {number} The ID of the new matcher, this can be used to deregister.
// */
// registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler , options?: any);
/**
* (EXPERIMENTAL) Registers a link matcher, allowing custom link patterns to
* be matched and handled.
* @param regex The regular expression to search for, specifically this
* searches the textContent of the rows. You will want to use \s to match a
* space ' ' character for example.
* @param handler The callback when the link is called.
* @param options Options for the link matcher.
* @return The ID of the new matcher, this can be used to deregister.
*/
registerLinkMatcher(regex: RegExp, handler: (event: MouseEvent, uri: string) => boolean | void , options?: any);
// /**
// * Deregisters a link matcher if it has been registered.
// * @param matcherId The link matcher's ID (returned after register)
// */
// deregisterLinkMatcher(matcherId: number): void;
/**
* (EXPERIMENTAL) Deregisters a link matcher if it has been registered.
* @param matcherId The link matcher's ID (returned after register)
*/
deregisterLinkMatcher(matcherId: number): void;
/**
* Gets whether the terminal has an active selection.