• Public
  • Public/Protected
  • All


  • HighlightedResultProps



children: ReactNode

The children to highlight. If this is not a string, the highlight will not work.

className?: string

An optional className to provide to the <span>.

enabled?: boolean

Boolean if the highlighting functionality should be enabled. Setting this to false will just return the children instead.

id?: string

An optional id to use for the <span>. This will be suffixed by the current index if it was provided

index?: number

The match index which is automatically added when the repeatable prop is used for nested matches.

repeatable?: boolean

Boolean if the highlighting can be repeated multiple times within the children string.

style?: CSSProperties

An optional style to provide to the <span>.

value: string

The current value to match against.

Generated using TypeDoc