Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-text-highlighter

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-text-highlighter

Simple higher order component for React for text highlighting. Works nicely with React 0.14+ and stateless components

  • 0.0.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

React-Text-Highlighter

Simple High Order Component that allows you to highlight your text based on text matches.

Why?

I needed a simple highlighter that works with React 0.14 and multiple non-connected words.

How to use?

npm install react-text-highlighter;

Create a component and wrap it in Highlighter.

Quick example using a stateless component:

import Highlighter from 'react-text-highlighter';
...

const MyComponent = ({highlightedText}) =>
<div id="result" dangerouslySetInnerHTML={{__html: highlightedText}}/>;

//!important
export default Highlighter(MyComponent);

Now you can cleanly add it like:

<HighLighter highlight={"Foo"} text={"Foo bar baz"} options={opts} />

Check the example dir for a simple example. You can run the example with: npm run example

Options

You need to pass an option object with the following properties:

{
  caseSensitive: true //true or false
  highlightClass: 'highlighted-text' // className for your highlighted text
}

dangerouslySetInnerHTML?

The component returns a HTML string which you need to set with dangerouslysetInnerHTML, otherwise highlighting highlighting multiple words becomes very complex. If you don't trust the source of your highlighted text. Use a library like DOMPurify. This allows you to:

import DOMPurify from 'dompurify';
...

<div dangerouslySetInnerHTML={ {__html: DOMPurify.sanitize(highlightedText)} }/>

Alternatives

Keywords

FAQs

Package last updated on 04 Nov 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc