Files
xterm.js/addons/addon-canvas
2024-07-07 09:15:25 -07:00
..
2024-07-07 09:15:25 -07:00
2023-11-01 10:35:10 -07:00
2024-07-05 11:48:42 -07:00
2023-11-01 10:35:10 -07:00
2024-01-13 13:23:57 -06:00

@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