| 1 | # React Taggy
|
| 2 |
|
| 3 | A simple React component for displaying user-defined entities within a block of text.
|
| 4 |
|
| 5 | ## Install
|
| 6 |
|
| 7 | `npm i --save react-taggy` or `yarn add react-taggy`
|
| 8 |
|
| 9 | ## Basic Usage
|
| 10 |
|
| 11 | React Taggy requires three props
|
| 12 | - `text`: (string || array) The text that will be displayed. May be a string, or an array of tokens.
|
| 13 | - `spans`: (array) The locations within the text that will get tagged.
|
| 14 | - `ents`: (array) The allowable entity types and the color of each unique tag type.
|
| 15 |
|
| 16 | ## License
|
| 17 |
|
| 18 | *react-taggy* is available under MIT. See LICENSE for more details.
|