xterm.js

Files

T

Daniel ImmsandCursor 7fbe5a27fa fix(addon-search): harden search state and lifecycle

Normalize and snapshot search options, clear stale decorations when
decorations are disabled, use try/finally for search events, and refresh
highlights without re-entering public navigation APIs.

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-05-25 19:15:28 -07:00

benchmark

chore(addon-search): improve benchmark coverage and eval thresholds

2026-05-25 17:43:19 -07:00

fixtures

Replace all instances of xterm-addon

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

src

fix(addon-search): harden search state and lifecycle

2026-05-25 19:15:28 -07:00

test

test(addon-search): remove debugger from integration tests

2026-05-25 18:02:22 -07:00

typings

docs(addon-search): align API docs with runtime behavior

2026-05-25 18:02:22 -07: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

LICENSE

Replace all instances of xterm-addon

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

package.json

chore(addon-search): improve benchmark coverage and eval thresholds

2026-05-25 17:43:19 -07:00

README.md

docs(addon-search): align API docs with runtime behavior

2026-05-25 18:02:22 -07:00

tsconfig.json

Add search benchmark

2026-05-25 16:34:58 -07:00

webpack.config.js

Fix addon resolve path

2024-07-14 08:52:15 -07:00

README.md

@xterm/addon-search

An addon for xterm.js that enables searching the buffer. This addon requires xterm.js v4+.

Install

npm install --save @xterm/addon-search

Usage

import { Terminal } from '@xterm/xterm';
import { SearchAddon } from '@xterm/addon-search';

const terminal = new Terminal();
const searchAddon = new SearchAddon();
terminal.loadAddon(searchAddon);
searchAddon.findNext('foo');

Search options

decorations: Highlight all matches and fire onDidChangeResults with result counts.
highlightLimit (constructor option): Caps how many matches are tracked/highlighted (default 1000).
incremental: Expands the current selection when the term still matches.
wholeWord, regex, caseSensitive: Control match semantics.

See the full API for more advanced usage.