Skip to content

Commit 3a6ec6c

Browse files
committed
feat(pencil): readme updated to trigger next minor release (react 18 support release)
1 parent 56238b8 commit 3a6ec6c

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

Diff for: README.md

+20-24
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,6 @@
1515

1616
Or see it on [Github Page](https://wwayne.github.io/react-tooltip).
1717

18-
## INACTIVE PROJECT
19-
20-
The future of this project will be discussed here: https://github.com/wwayne/react-tooltip/issues/794
21-
22-
We hope to identify a fork of this project which will be actively maintained and can accept PRs and publish regularly to NPM.
23-
24-
One current fork and npm package is at https://www.npmjs.com/package/react-tooltip-rc, but the publisher has not yet committed to further maintenance.
25-
26-
## Maintainers
27-
28-
[alexgurr](https://github.com/alexgurr) Casual maintainer - accepting PRs and doing minor testing/development.
29-
30-
[aronhelser](https://github.com/aronhelser) Passive maintainer - accepting PRs and doing minor testing, but not fixing issues or doing active development.
31-
32-
[roggervalf](https://github.com/roggervalf) inactive maintainer - no longer seems to be doing development.
33-
34-
[huumanoid](https://github.com/huumanoid) (inactive)
35-
36-
We would gladly accept a new maintainer to help out!
37-
3818
## Installation
3919

4020
```sh
@@ -119,8 +99,10 @@ Notes:
11999
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](https://www.npmjs.com/package/sanitize-html). 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.
120100

121101
#### JSX Note
102+
122103
You can use React's [`renderToStaticMarkup`-function](https://reactjs.org/docs/react-dom-server.html#rendertostaticmarkup) to use JSX instead of HTML. You still need to set `data-html={true}`.
123104
**Example:**
105+
124106
```jsx
125107
import ReactDOMServer from 'react-dom/server';
126108
[...]
@@ -196,22 +178,22 @@ Same for empty children, if you don't want show the tooltip when the children is
196178

197179
### 3. Tooltip not binding to dynamic content
198180

199-
When you render `<ReactTooltip>` ahead of dynamic content, and are using `data-for={id}` attributes
200-
on new dynamic content, the tooltip will not register its event listener.
181+
When you render `<ReactTooltip>` ahead of dynamic content, and are using `data-for={id}` attributes
182+
on new dynamic content, the tooltip will not register its event listener.
201183

202184
For example, you render a generic tooltip in the root of your app, then load a list of content async.
203185
Elements in the list use the `data-for={id}` attribute to bind the tooltip on hover.
204186
Since the tooltip has already scanned for data-tip these new elements will not trigger.
205187

206-
One workaround for this is to trigger `ReactTooltip.rebuild()` after the data load to scan for the attribute again,
188+
One workaround for this is to trigger `ReactTooltip.rebuild()` after the data load to scan for the attribute again,
207189
to allow event wireup.
208190

209191
#### Example
210192

211193
```jsx
212194
<app>
213195
<ReactTooltip id="foo" />
214-
<list/>
196+
<list />
215197
</app>
216198
```
217199

@@ -238,6 +220,20 @@ return(
238220

239221
[How I insert sass into react component](https://medium.com/@wwayne_me/how-i-insert-sass-into-my-npm-react-component-b46b9811c226#.gi4hxu44a)
240222

223+
## Maintainers
224+
225+
[danielbarion](https://github.com/danielbarion) Casual maintainer - accepting PRs and doing minor testing/development.
226+
227+
[alexgurr](https://github.com/alexgurr) Casual maintainer - accepting PRs and doing minor testing/development.
228+
229+
[aronhelser](https://github.com/aronhelser) Passive maintainer - accepting PRs and doing minor testing, but not fixing issues or doing active development.
230+
231+
[roggervalf](https://github.com/roggervalf) inactive maintainer - no longer seems to be doing development.
232+
233+
[huumanoid](https://github.com/huumanoid) (inactive)
234+
235+
We would gladly accept a new maintainer to help out!
236+
241237
## Contributing
242238

243239
We welcome your contribution! Fork the repo, make some changes, submit a pull-request! Our [contributing](contributing.md) doc has some details.

0 commit comments

Comments
 (0)