-
Notifications
You must be signed in to change notification settings - Fork 232
Make it much more prominent that only >= react@16.9.0 is supported #183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Hi @sgb-io, Sorry if you lost any time with this. PRs are always welcome for improving the documentation. I haven't yet seen the peer dependency be an issue for people. In fact, I didn't think it would cause a duplicate version issue at all as the whole point of a peer dependency is that the user must install the dependency themselves and you just get install time warnings about versions mismatches. You mentioned your types colliding, so this sounds more like the existing issue around how to deal with type dependencies, #110. If that's the case, I think we can close this issue and keep track of it in that one. |
Thanks @mpeyper, I think relocating the types is the right solution. The current collision problem means that effectively only 16.9.0+ is supported (for TypeScript users), but it sounds like your suggestion in #110 could solve the problem and therefore make more versions compatible for TypeScript users. |
Actually, I realised that the dependency on React 16.9.0 is a hard one, since you're using |
I've tried to make it stand out in the docs a bit more:
Happy to accept PRs to improve this further. |
Right now, this is mentioned like a footnote in the readme. I invested time to write tests on parts of our app using hooks, only to later discover that even with a quite modern version of React (16.8.6), the tests work, but the peer dependency requirement means I get two versions of React and therefore my types collide.
I think it would be courteous to make this more prominent at the top of the README.
The text was updated successfully, but these errors were encountered: