Skip to content

Commit

Permalink
Update README to direct users to specific version of typings (#8)
Browse files Browse the repository at this point in the history
See discussion at DefinitelyTyped/DefinitelyTyped#26363 -- typings for react-pointable had to be updated for compatibility with React 16.4 (since all of DefinitelyTyped is, unfortunately, versioned in lockstep). The upshot is that the latest version of @types/react-pointable will not expose pointer events when used with @types/react below 16.4.
  • Loading branch information
lostfictions authored and MilllerTime committed Jun 19, 2018
1 parent 412df1e commit 03446e4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,18 @@ All pointer events are supported:
[Here's a CodePen using Pointable](http://codepen.io/MillerTime/pen/QKaLky/) that allows toggling between pointer and mouse events, using the same components.

## TypeScript Typings
Typings for projects written in TypeScript are available on NPM:
Typings for react-pointable are available on NPM.

If you're using a version of React < 16.4, run
```
npm install --save-dev @types/react-pointable@1.1.3
```
If you happen to be using React 16.4+ and can't yet remove this package for some reason, you can instead run
```
npm install --save-dev @types/react-pointable
```
To learn more, see the discussion in the [DefinitelyTyped repo](https://github.com/DefinitelyTyped/DefinitelyTyped/pull/26363).


## License
MIT

0 comments on commit 03446e4

Please sign in to comment.