Material-ui: [docs] Supported React versions

Created on 31 Jul 2019  路  9Comments  路  Source: mui-org/material-ui

Not able to find the exact supported version for a particular version of MUI

Expected Behaviour

Supported version
React >=16.x
_Just an example_

Also, a table listing

| Material-UI | React |
| -------------|------|
| v4 | ^16.8.0 (hooks) |
| v3 | ^16.3.0 (context) |
| v1 | ^16.3.0 (context) |
| v0.20 | >= 15.4.0 |

Related #16828

docs

All 9 comments

@pranshuchittora Great idea!

Also the above is missing in the package docs => https://www.npmjs.com/package/@material-ui/core

Hence adding this info to the README.md, is also required.

Supported version

@pranshuchittora The supported version is in the peer dependencies:

https://github.com/mui-org/material-ui/blob/aea88b6bf4f25ce5dcaa19e08836eb6faad91386/packages/material-ui/package.json#L35-L36

You will have a warning at the installation if it's no supported.

Also, a table listing

Yeah, maybe we could do something as simple as:

diff --git a/docs/src/pages/getting-started/supported-platforms/supported-platforms.md b/docs/src/pages/getting-started/supported-platforms/supported-platforms.md
index 0816fc11c..1bdb87fb8 100644
--- a/docs/src/pages/getting-started/supported-platforms/supported-platforms.md
+++ b/docs/src/pages/getting-started/supported-platforms/supported-platforms.md
@@ -25,9 +25,18 @@ We also try to support the [LTS versions that are in maintenance](https://github

 The CSS served on this documentation is processed with [`autoprefixer`](https://www.npmjs.com/package/autoprefixer).
 You can use [the documentation implementation](https://github.com/mui-org/material-ui/blob/47aa5aeaec1d4ac2c08fd0e84277d6b91e497557/pages/_document.js#L123) as inspiration.
 Be aware that it has an implication with the performance of the page.
 It's a must do for static pages, but it needs to be put in balance with not doing anything when rendering dynamic pages.
+
+## React
+
+We support React starting with the version ^16.8.0 (the one with the hooks).

?

@oliviertassinari before proceeding with the changes let's finalise the places where it's required.

So let's make a list of the required places.

  • Adding to the hosted docs
  • npm page (adding to README.md would fix it)
  • After Installing

Feel free to update this comment :+1:

@pranshuchittora I think that updating the supported-platforms.md would be enough. It's not incredibly important. People starting don't have to worry. I would only expect advanced users to have this problem, people that should be able to find the information from the source. What do you think?

Frankly speaking, I get really frustrated when my terminal gets filled with a huge mess of information, after install modules.

The ideal solution would make this information accessible, easily.
Hence adding it to supported-platform would be an ideal solution.

@oliviertassinari Shall I raise a PR against this issue?

Yes, please, go ahead :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tleunen picture tleunen  路  59Comments

damianobarbati picture damianobarbati  路  55Comments

NonameSLdev picture NonameSLdev  路  56Comments

amcasey picture amcasey  路  70Comments

Bessonov picture Bessonov  路  93Comments