kristofferh / react-highlight-words

React component to highlight words within a larger body of text

React component to highlight words within a larger body of text.

Check out a demo here.

Usage

To use it, just provide it with an array of search terms and a body of text to highlight:

<Highlighter
  highlightClassName='YourHighlightClass'
  searchWords={['and', 'or', 'the']}
  textToHighlight="The dog is chasing the cat. Or perhaps they're just playing?"
/>

And the Highlighter will mark all occurrences of search terms within the text:

Props

Property	Type	Required?	Description
activeClassName	String		The class name to be applied to an active match. Use along with activeIndex
activeIndex	String		Specify the match index that should be actively highlighted. Use along with activeClassName
activeStyle	Object		The inline style to be applied to an active match. Use along with activeIndex
autoEscape	Boolean		Escape characters which are meaningful in regular expressions
className	String		CSS class name applied to the outer/wrapper <span>
highlightClassName	String		CSS class name applied to highlighted text
highlightStyle	Object		Inline styles applied to highlighted text
highlightTag	Node		Type of tag to wrap around highlighted matches; defaults to mark but can also be a React element (class or functional)
sanitize	Function		Process each search word and text to highlight before comparing (eg remove accents); signature (text: string): string
searchWords	Array	✓	Array of search words
textToHighlight	String	✓	Text to highlight matches in
unhighlightClassName	String		CSS class name applied to unhighlighted text
unhighlightStyle	Object		Inline styles applied to unhighlighted text

Installation

npm i --save react-highlight-words

License

MIT License - fork, modify and use however you want.