a TypeScript rewrite of the package react-highlighter
npm install react-highlighter-ts
This is a TypeScript rewrite of the npm packagereact-highligher, which has no
type support, has very out of date dependencies, and seems to be abandoned (no
activity since 2018).
Starting with version 18.0.0, this library's major version number will be pinned to the compatible major version of React.
For React version 17.x compatability, install version ^2.2.0.
The API for this package is identical to that of the original package,react-highlighter.
``tsx
import * as React from "react";
import { Highlight } from "react-highlighter-ts";
export const Example = () => (
);
`
See generated type
documentation for details on
properties accepted by .
By default, this library wraps matches in an html tag, and does not
style it. Most browsers style the tag by giving it a yellow backgroundmatchElement
and black text. You can style your matches by providing a pre-styled
element type to , passing a CSS class to matchClass, or passingmatchStyle
CSS rules to .
You should be able to migrate directly from react-highlighter toreact-highlighter-ts without any changes in your source code besides adjusting
your imports.
See something amiss? Please open a PR.
This library does not use any global dependencies, so a simple npm install
should suffice.
Tests have been adapted from the original react-highlighter codebase. Tests
use Jest + Enzyme.
`sh`
npm run test
or to watch file changes:
`sh``
npm run test:watch