xterm-link-provider

xterm-link-provider

Create a Link Provider for xterm.js using regex (based on xterm-addon-web-links' WebLinkProvider class)

Install

$ npm install --save xterm-link-provider @xterm/xterm

Note: Version 2.0.0+ requires @xterm/xterm ^6.0.0. For older versions of xterm.js (4.x), use xterm-link-provider 1.x.

Usage

import {LinkProvider} from 'xterm-link-provider';
import {Terminal} from '@xterm/xterm';

// print clicked emojis to console

const emojiRegex = /(\p{Emoji_Presentation}+)/gu

terminal.registerLinkProvider(
  new LinkProvider(
    terminal,
    emojiRegex,
    (e, text) => {
      console.log(text)
    }
  )
)

Version Compatibility

• v2.x: Compatible with @xterm/xterm ^6.0.0
• v1.x: Compatible with xterm ^4.11.0