Skip to content

Update README to direct users to specific version of typings#8

Merged
MilllerTime merged 2 commits intoMilllerTime:masterfrom
lostfictions:patch-1
Jun 19, 2018
Merged

Update README to direct users to specific version of typings#8
MilllerTime merged 2 commits intoMilllerTime:masterfrom
lostfictions:patch-1

Conversation

@lostfictions
Copy link
Contributor

@lostfictions lostfictions commented Jun 18, 2018

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 <16.4.

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.
@MilllerTime
Copy link
Owner

Nice, thanks for helping to get the React types straightened out!

Copy link
Owner

@MilllerTime MilllerTime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a TypeScript novice, but I understand that installing the latest version of @types/react-pointable with an older version of React would break things. I would think it might be helpful to consumers of this package if there was a bit more information about this situation. Something like:

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 at DefinitelyTyped/DefinitelyTyped#26363

There may be a better way to explain this, and I could also be overthinking this entirely.

@lostfictions
Copy link
Contributor Author

@MilllerTime Sounds good to me -- I've amended the PR.

@MilllerTime
Copy link
Owner

Cool. Thanks again.

@MilllerTime MilllerTime merged commit 03446e4 into MilllerTime:master Jun 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants