Skip to content

Commit 4609833

Browse files
authored
Merge pull request #550 from wwayne/refactoring
BREAKING CHANGE: Updating readme for demo
2 parents f604290 + 9dbf7a2 commit 4609833

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

Diff for: README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
[download-image]: https://img.shields.io/npm/dm/react-tooltip.svg?style=flat-square
88
[download-url]: https://npmjs.org/package/react-tooltip
99

10+
## Demo
11+
12+
[![Edit ReactTooltip](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/heuristic-curran-bddeu?fontsize=14&hidenavigation=1&theme=dark)
13+
1014
## Maintainers
1115

1216
[aronhelser](https://github.com/aronhelser) Passive maintainer - accepting PRs and doing minor testing, but not fixing issues or doing active development.
@@ -26,7 +30,7 @@ npm install react-tooltip
2630
or
2731

2832
```sh
29-
yarn react-tooltip
33+
yarn add react-tooltip
3034
```
3135

3236
## Usage
@@ -94,9 +98,6 @@ className | data-class | String | | extra custom class, can use !importan
9498

9599
The `html` option allows a tooltip to directly display raw HTML. This is a security risk if any of that content is supplied by the user. Any user-supplied content must be sanitized, using a package like [sanitize-html-react](https://www.npmjs.com/package/sanitize-html-react). We chose not to include sanitization after discovering it [increased our package size](https://github.com/wwayne/react-tooltip/issues/429) too much - we don't want to penalize people who don't use the `html` option.
96100

97-
## Using react component as tooltip
98-
Check the example [React-tooltip Test](https://react-tooltip.netlify.com/)
99-
100101
##### Note:
101102
1. **data-tip** is necessary, because `<ReactTooltip />` finds the tooltip via this attribute
102103
2. **data-for** corresponds to the **id** of `<ReactTooltip />`

0 commit comments

Comments
 (0)