# @xterm/addon-canvas

> An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.

Latest version **0.7.0** (published 2024-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xterm/addon-canvas
pnpm add @xterm/addon-canvas
yarn add @xterm/addon-canvas
bun add @xterm/addon-canvas
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.7.0 |
| Published | 2024-04-05 |
| First published | 2023-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 528 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21186 |
| Author | The xterm.js authors |
| Maintainers | tyriar |
| Keywords | terminal, canvas, xterm, xterm.js |

## Links

- npm: https://www.npmjs.com/package/@xterm/addon-canvas
- Repository: https://github.com/xtermjs/xterm.js.git#master
- Homepage: https://github.com/xtermjs/xterm.js/tree/master#readme
- Issues: https://github.com/xtermjs/xterm.js/issues
- npm.io page: https://npm.io/package/@xterm/addon-canvas

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.7.0 (latest) — 2024-04-05
- 0.8.0-beta.48 (beta) — 2024-07-14
- 0.8.0-beta.47 — 2024-07-14
- 0.8.0-beta.46 — 2024-07-11
- 0.8.0-beta.45 — 2024-07-11
- 0.8.0-beta.44 — 2024-07-11
- 0.8.0-beta.43 — 2024-07-09
- 0.8.0-beta.42 — 2024-07-09
- 0.8.0-beta.41 — 2024-07-07
- 0.8.0-beta.40 — 2024-07-07
- 0.8.0-beta.39 — 2024-07-05
- 0.8.0-beta.38 — 2024-07-05
- 0.8.0-beta.37 — 2024-07-05
- 0.8.0-beta.36 — 2024-07-04
- 0.8.0-beta.35 — 2024-07-03
- … 81 more at https://npm.io/package/@xterm/addon-canvas/versions

## README

## @xterm/addon-canvas

An addon for [xterm.js](https://github.com/xtermjs/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](https://www.npmjs.com/package/@xterm/addon-webgl) when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.

### Install

```bash
npm install --save @xterm/addon-canvas
```

### Usage

```ts
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](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-canvas/typings/addon-canvas.d.ts) for more advanced usage.

### See also

- [@xterm/addon-webgl](https://www.npmjs.com/package/@xterm/addon-webgl) A renderer for xterm.js that uses WebGL

---
_Source: https://npm.io/package/@xterm/addon-canvas · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._