xterm.js

Files

T

Cursor AgentandDaniel Imms 5070a08b58 Move Color to base; slim services/Types; colocate ICoreTerminal

- Restore Color.ts under common/base/ (not services)
- Add base/ColorTypes (IColor, IColorRGB)
- Add terminal/CoreTerminalTypes (ICoreTerminal, IScrollEvent, XtermListener)
- Add terminal/InputHandlerTypes and input/WindowOptions for handler types
- services/Types.ts: service-only (modes, mouse, osc link, cursor styles)
- Update imports across src, addons, browser; re-export KeyboardResultType removed
- browser tsconfig: exclude unit tests from composite build

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>

2026-05-30 17:45:15 +00:00

benchmark

Restructure common into layered folders (issue #5963 )

2026-05-30 16:12:18 +00:00

src

Move Color to base; slim services/Types; colocate ICoreTerminal

2026-05-30 17:45:15 +00:00

test

Ignore cache keys in serialize addon

2026-05-02 06:21:42 -07:00

typings

pass in startLine, endLine, startCol

2025-10-28 11:46:41 -04:00

.gitignore

Replace all instances of xterm-addon

2023-11-01 10:35:10 -07:00

.npmignore

Publish addon mjs files

2024-07-07 09:15:25 -07:00

package.json

Migrate to tsgo

2026-02-13 06:59:24 -08:00

README.md

Move to npm

2025-11-23 09:01:24 -08:00

tsconfig.json

Replace all instances of xterm-addon

2023-11-01 10:35:10 -07:00

webpack.config.js

Update webpack.config.js global object fix

2024-01-13 13:29:20 -06:00

README.md

@xterm/addon-serialize

An addon for xterm.js that enables xterm.js to serialize a terminal framebuffer into string or html. This addon requires xterm.js v4+.

⚠️ This is an experimental addon that is still under construction ⚠️

Install

npm install --save @xterm/addon-serialize

Usage

import { Terminal } from "@xterm/xterm";
import { SerializeAddon } from "@xterm/addon-serialize";

const terminal = new Terminal();
const serializeAddon = new SerializeAddon();
terminal.loadAddon(serializeAddon);

terminal.write("something...", () => {
  console.log(serializeAddon.serialize());
});

See the full API for more advanced usage.

Benchmark

⚠️ Ensure you have lolcat, hexdump programs installed in your computer

$ git clone https://github.com/xtermjs/xterm.js.git
$ cd xterm.js
$ npm ci
$ cd addons/addon-serialize
$ npm run benchmark && npm run benchmark-baseline
$ # change some code in `@xterm/addon-serialize`
$ npm run benchmark-eval