react-highlighter

WebJar for react-highlighter

License	MIT
Categories	React User Interface Web Frameworks
GroupId	org.webjars.npm
ArtifactId	react-highlighter
Last Version	0.4.0
Release Date	Sep 23, 2017
Type	jar
Description	react-highlighter WebJar for react-highlighter
Project URL	http://webjars.org
Source Code Management	https://github.com/helior/react-highlighter

Download react-highlighter

Filename	Size
react-highlighter-0.4.0.pom
react-highlighter-0.4.0.jar	8 KB
react-highlighter-0.4.0-sources.jar	22 bytes
react-highlighter-0.4.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/react-highlighter/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>react-highlighter</artifactId>
    <version>0.4.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/react-highlighter/
implementation 'org.webjars.npm:react-highlighter:0.4.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/react-highlighter/
implementation ("org.webjars.npm:react-highlighter:0.4.0")

Apache Buildr

'org.webjars.npm:react-highlighter:jar:0.4.0'

Apache Ivy

<dependency org="org.webjars.npm" name="react-highlighter" rev="0.4.0">
  <artifact name="react-highlighter" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='react-highlighter', version='0.4.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "react-highlighter" % "0.4.0"

Leiningen

[org.webjars.npm/react-highlighter "0.4.0"]

Dependencies

compile (4)

Group / Artifact	Type	Version
org.webjars.npm : blacklist	jar	[1.1.2,2)
org.webjars.npm : create-react-class	jar	[15.5.2,16)
org.webjars.npm : escape-string-regexp	jar	[1.0.5,2)
org.webjars.npm : prop-types	jar	[15.5.8,16)

Project Modules

There are no modules declared in this project.

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.

Versions

Version
0.4.0 Sep 23, 2017
0.3.3 Sep 14, 2016