Skip to main content

MatchHighlight

Display

Wraps query matches inside a string in real <mark> elements, styled with the semantic --highlight token pair (AA-legible ink in every theme).

import { MatchHighlight } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui MatchHighlight component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look MatchHighlight up before writing code: `npx -y @elabs-ai/components-cli docs MatchHighlight` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

8 live examples

In Paragraph

A search-result title inside a paragraph — the canonical omnisearch use.

Multiple Needles

Multiple needles (e.g. every token of a multi-word query).

Precomputed Ranges

Precomputed ranges from a fuzzy matcher (overlapping/adjacent are merged).

Current Match

`activeIndex` marks ONE of the matches as the current one — the "3 of 12" a find bar or a document citation is pointing at. It is never colour-only: the current mark also carries an outline and `aria-current="true"`, and it can be found for scrolling via `[data-slot="match-highlight-mark"][data-active]`.

Stepping Through Matches

Stepping through matches — what a find bar drives.

No Match

No match → the string renders normally (never broken markup).

Long String Truncation

Long content truncates cleanly. The flex child needs `min-w-0` for `truncate` to engage (the interaction-guidelines "silent culprit").

API

MatchHighlight

PropTypeDescription
textrequiredstringThe full string to render.
querystring | string[]One or more needles to highlight. Case-insensitive by default. Ignored when `ranges` is supplied.
rangesreadonly MatchRange[]Precomputed match ranges (e.g. from a fuzzy matcher / MiniSearch). Wins over `query` when supplied. Overlapping and adjacent ranges are merged.
caseSensitivebooleanMatch `query` case-sensitively. @default false
activeIndexnumberWhich mark is the CURRENT one, 0-based among the resolved (merged, sorted) ranges. `-1` or omitted means none is. "One of twelve" and "the one you are on" are different meanings, so the current mark gets its own token pair rather than an opacity tweak — and, because colour is never the only channel (WCAG 1.4.1), an outline and `aria-current="true"` as well. It also carries `data-active`, which is how a caller finds it to scroll it into view: `root.querySelector('[data-slot="match-highlight-mark"][data-active]')`.

Also accepts: HTMLAttributes<HTMLSpanElement>