`<Highlight>` props

import { Highlight } from 'one-more-highlight';

Required props

Prop	Type	Description
`text`	`string`	The text to search and render.
`searchWords`	`Array<string \| RegExp>`	Terms to find. String terms are auto-escaped by default. RegExps are cloned with `g` flag forced on.

Prop	Type	Default	Description
`caseSensitive`	`boolean`	`false`	Match case (string terms only; regex flags are honored as-is).
`autoEscape`	`boolean`	`true`	Escape regex special chars in string terms.
`sanitize`	`(s: string) => string`	—	Pre-process text and search source before matching. Use for diacritic-insensitive search.
`findChunks`	`(input: FindChunksInput) => RawChunk[]`	—	Custom matcher; completely replaces the default `matchAll`-based implementation.
`overlapStrategy`	`'merge' \| 'nest' \| 'first-wins'`	`'merge'`	How overlapping matches are resolved.

Prop	Type	Default	Description
`states`	`HighlightState[]`	—	Per-match layered styling. Each entry selects a subset of matches and applies a className and/or style on top of the base.

Prop	Type	Default	Description
`highlightTag`	`keyof JSX.IntrinsicElements \| ComponentType`	`'mark'`	Element or component for matches. Custom components receive `matchIndex` and `states` as extra props.
`highlightClassName`	`string`	—	Base className applied to every match.
`highlightStyle`	`CSSProperties`	—	Base inline style applied to every match.
`unhighlightTag`	`keyof JSX.IntrinsicElements`	—	Element to wrap non-match segments (default: no wrapper).
`unhighlightClassName`	`string`	—	className for non-match wrappers (only applied when `unhighlightTag` is set).
`unhighlightStyle`	`CSSProperties`	—	Inline style for non-match wrappers.
`renderMatch`	`(seg: MatchSegment, defaults: MatchDefaults) => ReactNode`	—	Full render-prop control over match output.

Prop	Type	Default	Description
`as`	`keyof JSX.IntrinsicElements`	`'span'`	Root wrapper element.
`className`	`string`	—	className on the root wrapper.
`style`	`CSSProperties`	—	Inline style on the root wrapper.

Additional HTML attributes are forwarded to the root element.

<Highlight> is wrapped with forwardRef — you can pass a ref and it will be attached to the root element (the as element, default <span>).

When you pass a RegExp instance in searchWords, <Highlight> does three things to avoid common footguns:

Clones the regex so the consumer-supplied object's lastIndex is never mutated (regex objects carry stateful lastIndex when used with g or y flags).
Forces the g flag on in the clone so matchAll walks the full string.
Drops the sticky y flag from the clone, because anchored sticky matching is incompatible with this component's "find all occurrences" semantics. A one-time console.warn fires in development (NODE_ENV !== 'production') when a sticky regex is passed.

The original regex you passed in is never modified.