Package Exports

react-highlighter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-highlighter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-highlighter

Highlight select fragments of a string using an HTML element and/or a class.

Installation

npm install react-highlighter --save

Usage

var Highlight = require('react-highlighter');

<Highlight search="brown">The quick brown fox jumps over the lazy dog</Highlight>

Props

search: The string of text (or Regular Expression) to highlight
caseSensitive: Determine whether string matching should be case-sensitive. Not applicable to regular expression searches. Defaults to false
ignoreDiacritics: Determine whether string matching should ignore diacritics. Defaults to false
diacriticsBlacklist: These chars are treated like characters that don't have any diacritics. Not applicable ignoreDiacritics is false. Defaults to none
matchElement: HTML tag name to wrap around highlighted text. Defaults to mark
matchClass: HTML class to wrap around highlighted text. Defaults to highlight
matchStyle: Custom style for the match element around highlighted text.

Development

Testing

Using Mocha/Chai/React.addons.TestUtils for testing.

npm test

Code Coverage

Generate a report using Istanbul to make sure your tests are touching everything! FYI, Travis will fail the build if there isn't at least 90% of statement coverage and 100% function coverage.

npm run coverage

Coveralls.io integration requires that the environment variable COVERALLS_REPO_TOKEN is set.