vercel/hyper

Add a way for plugins to add xterm addons

Open

#2,903 opened on Apr 22, 2018

View on GitHub
 (2 comments) (5 reactions) (0 assignees)TypeScript (3,558 forks)batch import
help wanted🛠 Type: Feature Request

Repository metrics

Stars
 (44,582 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

xtermjs offers a way to enhance its API: https://xtermjs.org/docs/guides/using-addons/

We need to find a way to let plugins add some addons.

Proposal:

// Plugin side
import * as zmodem from 'xterm/lib/addons/zmodem/zmodem';

exports.getXtermAddons() {
  return zmodem // [zmodem] will work too
}

On Hyper side, we need to execute this method for all plugins (each time they've changed) to get all these addons and apply them with:

  Terminal.applyAddon(pluginAddon);

Contributor guide