Skip to content
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

[docs] List dependencies, eg React 16 #12110

Closed
2 tasks done
bluerface opened this issue Jul 11, 2018 · 3 comments
Closed
2 tasks done

[docs] List dependencies, eg React 16 #12110

bluerface opened this issue Jul 11, 2018 · 3 comments
Labels
docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process.

Comments

@bluerface
Copy link

bluerface commented Jul 11, 2018

It seems like very important top level information that the new version depends on React 16. I believe this should be visible somewhere in getting started AND the migration guide.

Context

I was half way through attempting to upgrade typescript before I saw in the console that it depended on react 16 (which we may or may not be able to upgrade right now). Its not a hard problem but it wasted quite a bit of my time for no real reason

  • This is a v1.x issue (v0.x is no longer maintained).
  • I have searched the issues of this repository and believe that this is not a duplicate.
Tech Version
Material-UI v1.0.0 docs
@oliviertassinari
Copy link
Member

You can still use React 15.x with v1.0.0-beta.47. The React dependency version shouldn't matter for people starting with React. For people already using it, well, they kind of already know they can't use two React versions at the same time. You can have to access to the peer dependencies in http://unpkg.com/@material-ui/core/package.json.
Anyway, I agree, documenting it won't harm.

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. labels Jul 11, 2018
@chenop
Copy link
Contributor

chenop commented Jul 14, 2018

Hi @oliviertassinari , I would like to fix that, what is the best way documenting that React 16 is a dependency?

@oliviertassinari
Copy link
Member

@chenop We can talk about the React >= 16.3.0 peer dependency requirement in https://material-ui.com/getting-started/installation/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process.
Projects
None yet
Development

No branches or pull requests

3 participants