Skip to content

Commit 6212b95

Browse files
committed
docs: update readme to match the next version of react-tooltip
1 parent 15ef349 commit 6212b95

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

README.md

+19-22
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[![npm download][download-image]][download-url]
77
![minified](https://badgen.net/bundlephobia/min/react-tooltip)
88
![minified gzip](https://badgen.net/bundlephobia/minzip/react-tooltip)
9+
910
<!-- ![last commit](https://badgen.net/github/last-commit/reacttooltip/react-tooltip) -->
1011

1112
[download-image]: https://img.shields.io/npm/dm/react-tooltip.svg?style=flat-square
@@ -17,7 +18,7 @@
1718
</a>
1819
</p>
1920

20-
If you like the project, please give the project a GitHub 🌟
21+
If you like the project, please give the project a GitHub 🌟
2122

2223
## Demo
2324

@@ -55,20 +56,23 @@ yarn add react-tooltip
5556

5657
## Usage
5758

59+
> :warning: ReactTooltip will inject the default styles into the page by default on version `5.13.0` or newer.
60+
> The `react-tooltip/dist/react-tooltip.css` file is only for style reference and doesn't need to be imported manually anymore if you are already using `v5.13.0` or upper.
61+
5862
> :warning: If you were already using `react-tooltip<=5.7.5`, you'll be getting some deprecation warnings regarding the `anchorId` prop and some other features.
59-
In versions >=5.8.0, we've introduced the `data-tooltip-id` attribute, and the `anchorSelect` prop, which are our recommended methods of using the tooltip moving forward. Check [the docs](https://react-tooltip.com/docs/getting-started) for more details.
63+
> In versions >=5.8.0, we've introduced the `data-tooltip-id` attribute, and the `anchorSelect` prop, which are our recommended methods of using the tooltip moving forward. Check [the docs](https://react-tooltip.com/docs/getting-started) for more details.
6064
6165
### Using NPM package
6266

6367
1 . Import the CSS file to set default styling.
6468

65-
> :warning: You must import the CSS file or the tooltip won't show!
69+
> :warning: If you are using a version before than `v5.13.0`, you must import the CSS file or the tooltip won't show!
6670
6771
```js
6872
import 'react-tooltip/dist/react-tooltip.css'
6973
```
7074

71-
This needs to be done only once. We suggest you do it on your `src/index.js` or equivalent file.
75+
This needs to be done only once and only if you are using a version before than `5.13.0`. We suggest you do it on your `src/index.js` or equivalent file.
7276

7377
2 . Import `react-tooltip` after installation.
7478

@@ -123,7 +127,7 @@ You can import `node_modules/react-tooltip/dist/react-tooltip.[mode].js` into yo
123127

124128
mode: `esm` `cjs` `umd`
125129

126-
Don't forget to import the CSS file from `node_modules/react-tooltip/dist/react-tooltip.css` to set default styling. This needs to be done only once in your application.
130+
If you are using a version older than `v5.13.0` don't forget to import the CSS file from `node_modules/react-tooltip/dist/react-tooltip.css` to set default styling. This needs to be done only once in your application. Version `v5.13.0` or newer already inject the default styles into the page by default.
127131

128132
PS: all the files have a minified version and a non-minified version.
129133

@@ -145,7 +149,7 @@ You can use [`renderToStaticMarkup()` function](https://reactjs.org/docs/react-d
145149
```jsx
146150
import ReactDOMServer from 'react-dom/server';
147151
[...]
148-
<a
152+
<a
149153
data-tooltip-id="my-tooltip"
150154
data-tooltip-html={ReactDOMServer.renderToStaticMarkup(<div>I am <b>JSX</b> content</div>)}
151155
>
@@ -172,7 +176,7 @@ If there isn't, feel free to [submit a new issue](https://github.com/ReactToolti
172176

173177
### The tooltip is broken/not showing up
174178

175-
Make sure you've imported the default styling. You only need to do this once on your application, `App.jsx`/`App.tsx` is usually a good place to do it.
179+
Make sure you've imported the default styling. You only need to do this once on your application and only if you are using a version before `5.13.0`, `App.jsx`/`App.tsx` is usually a good place to do it.
176180

177181
```jsx
178182
import 'react-tooltip/dist/react-tooltip.css'
@@ -184,7 +188,7 @@ If `data-tooltip-content` and `data-tooltip-html` are both unset (or they have e
184188

185189
### Next.js `TypeError: f is not a function`
186190

187-
This problem seems to be caused by a bug related to the SWC bundler used by Next.js.
191+
This problem seems to be caused by a bug related to the SWC bundler used by Next.js.
188192
The best way to solve this is to upgrade to `[email protected]` or later versions.
189193

190194
Less ideally, if you're unable to upgrade, you can set `swcMinify: false` on your `next.config.js` file.
@@ -199,7 +203,7 @@ This is specially relevant when using components that are conditionally rendered
199203

200204
Always try to keep the `<Tooltip />` component rendered, so if you're having issues with a tooltip you've placed inside a component which is placed/removed from the DOM dynamically, try to move the tooltip outside of it.
201205

202-
We usually recommend placing the tooltip component directly inside the root component of your application (usually on `App.jsx`/`App.tsx`). You can also move the `import 'react-tooltip/dist/react-tooltip.css'` there.
206+
We usually recommend placing the tooltip component directly inside the root component of your application (usually on `App.jsx`/`App.tsx`).
203207

204208
#### Dynamically generated anchor elements
205209

@@ -212,18 +216,12 @@ Here's a simple example on how to improve performance when using dynamically gen
212216
```jsx
213217
// ❌ BAD
214218
<div className="items-container">
215-
{
216-
myItems.map(({ id, content, tooltip }) => (
217-
<div
218-
key={id}
219-
className="item"
220-
data-tooltip-id={`tooltip-${id}`}
221-
>
222-
{content}
223-
<Tooltip id={`tooltip-${id}`} content={tooltip} />
224-
</div>
225-
))
226-
}
219+
{myItems.map(({ id, content, tooltip }) => (
220+
<div key={id} className="item" data-tooltip-id={`tooltip-${id}`}>
221+
{content}
222+
<Tooltip id={`tooltip-${id}`} content={tooltip} />
223+
</div>
224+
))}
227225
</div>
228226
```
229227

@@ -268,7 +266,6 @@ Here's a simple example on how to improve performance when using dynamically gen
268266

269267
[wwayne](https://github.com/wwayne) (inactive) - Creator of the original React Tooltip (V1.x ~ V4.x.)
270268

271-
272269
We would gladly accept a new maintainer to help out!
273270

274271
## Contributing

0 commit comments

Comments
 (0)