Files
xterm.js/addons/addon-search/README.md
T
Daniel ImmsandCursor 74bec251e6 docs(addon-search): align API docs with runtime behavior
Clarify incremental search, result event semantics, highlightLimit, and
optional decoration overview ruler fields.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-25 18:02:22 -07:00

965 B

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.