JSPM

@xterm/addon-canvas

0.8.0-beta.18
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 58114
  • Score
    100M100P100Q162777F
  • License MIT

Package Exports

  • @xterm/addon-canvas
  • @xterm/addon-canvas/lib/addon-canvas.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@xterm/addon-canvas) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@xterm/addon-canvas

An addon for xterm.js that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.

The purpose of this addon is to be used as a fallback for the webgl addon when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.

Install

npm install --save @xterm/addon-canvas

Usage

import { Terminal } from '@xterm/xterm';
import { CanvasAddon } from '@xterm/addon-canvas';

const terminal = new Terminal();
terminal.open(element);
terminal.loadAddon(new CanvasAddon());

See the full API for more advanced usage.

See also