Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HighlightedResultProps

Hierarchy

  • HighlightedResultProps

Index

Properties

children

children: ReactNode

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

Optional className

className: string

An optional className to provide to the <span>.

Optional enabled

enabled: boolean

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

Optional id

id: string

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

Optional index

index: number

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

Optional repeatable

repeatable: boolean

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

Optional style

style: CSSProperties

An optional style to provide to the <span>.

value

value: string

The current value to match against.

Generated using TypeDoc