Skip to content

Commit

Permalink
[docs] Fix outdated references to Materal UI version (#43321)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Aug 16, 2024
1 parent 0e4d904 commit d14751e
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,10 @@ This prop lets you write inline styles using a superset of CSS.
Learn more about [the concept behind the `sx` prop](/system/getting-started/the-sx-prop/) and [how `sx` differs from the `styled` utility](/system/styled/#difference-with-the-sx-prop).

You can use the `sx` prop inside the `styleOverrides` key to modify styles within the theme using shorthand CSS notation.
This is especially handy if you're already using the `sx` prop with your components, because you can use the same syntax in your theme and quickly transfer styles between the two.
This is especially handy if you're already using the `sx` prop with your components because you can use the same syntax in your theme and quickly transfer styles between the two.

:::info
The `sx` prop is a stable feature for customizing components in Material UI v5, but it is still considered _experimental_ when used directly inside the theme object.
The `sx` prop is a stable feature for customizing components since Material UI v5, but it is still considered _experimental_ when used directly inside the theme object.
:::

{{"demo": "GlobalThemeOverrideSx.js", "defaultCodeOpen": false}}
Expand Down
4 changes: 2 additions & 2 deletions docs/data/material/getting-started/overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ title: Overview

Material UI is an open-source React component library that implements Google's [Material Design](https://m2.material.io/).

It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box, and features a suite of customization options that make it easy to implement your own custom design system on top of our components.
It includes a comprehensive collection of prebuilt components that are ready for use in production right out of the box and features a suite of customization options that make it easy to implement your own custom design system on top of our components.

:::info
Material UI v5 supports Material Design 2.
Material UI v6 supports Material Design 2.
Adoption of Material Design 3 is tentatively planned for Material UI v7—see [the announcement blog post](/blog/2023-material-ui-v6-and-beyond/) for more details.
You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/29345) for future updates.
:::
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-cra-tailwind-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ or:
## The idea behind the example

This example demonstrates how you can use [Tailwind CSS](https://tailwindcss.com/) and [Create React App](https://github.com/facebookincubator/create-react-app) together with Material UI.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.

## What's next?

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-cra-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ or:
## The idea behind the example

This example demonstrates how you can use Material UI with [Create React App](https://github.com/facebookincubator/create-react-app) in [TypeScript](https://github.com/Microsoft/TypeScript).
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## What's next?
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-cra/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ or:
<!-- #default-branch-switch -->

This example demonstrates how you can use [Create React App](https://github.com/facebookincubator/create-react-app) with Material UI.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## What's next?
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-express-ssr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ or:

This is the reference implementation of the [Server Rendering tutorial](https://next.mui.com/material-ui/guides/server-rendering/).

The example project includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
The example project includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## What's next?
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-gatsby/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ npm run develop
## The idea behind the example

The project uses [Gatsby](https://github.com/gatsbyjs/gatsby), which is a static site generator for React.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## What's next?
Expand Down
3 changes: 2 additions & 1 deletion examples/material-ui-nextjs-pages-router-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ As of Next.js 13.4, the newer App Router pattern is stable.
We recommend starting new projects with the [Material UI with Next.js (App Router) example](https://github.com/mui/material-ui/tree/next/examples/material-ui-nextjs-ts) unless you need (or prefer) the Pages Router.

The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## The link component

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-nextjs-pages-router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ As of Next.js 13.4, the newer App Router pattern is stable.
We recommend starting new projects with the [Material UI with Next.js (App Router) example](https://github.com/mui/material-ui/tree/next/examples/material-ui-nextjs) unless you need (or prefer) the Pages Router.

The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## The Link component
Expand Down
6 changes: 4 additions & 2 deletions examples/material-ui-nextjs-ts-v4-v5-migration/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Material UI v5 and Next.js example with @mui/styles (in TypeScript)
# Material UI and Next.js example with @mui/styles (in TypeScript)

## How to use

Expand Down Expand Up @@ -29,7 +29,9 @@ or:
## The idea behind the example

The project uses [Next.js](https://github.com/vercel/next.js), which is a framework for server-rendered React apps.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5. If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

It also includes `@mui/styles`, the legacy styling solution that uses JSS as an engine.
It provides all the necessary config for working with both Emotion and JSS for server-side rendering.
The project is intended as a basic starter for migrating your application from v4 to v5, as it lets the JSS style overrides take precedence over the default styles passed to the components by Emotion.
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The project uses Material UI with [Preact](https://github.com/developit/preact)

This example uses CRA with `react-app-rewired` for adding Webpack aliases for Preact.

It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.

<!-- #default-branch-switch -->

Expand Down
4 changes: 2 additions & 2 deletions examples/material-ui-remix-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ or:

## The idea behind the example

The project uses [Remix](https://remix.run/), which is a full stack web framework.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
The project uses [Remix](https://remix.run/), which is a full-stack web framework.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
If you prefer, you can [use styled-components instead](https://next.mui.com/material-ui/integrations/interoperability/#styled-components).

## What's next?
Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-vite-ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ or:
## The idea behind the example

This example uses [Vite.js](https://github.com/vitejs/vite).
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.

## What's next?

Expand Down
2 changes: 1 addition & 1 deletion examples/material-ui-vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ or:
## The idea behind the example

This example uses [Vite.js](https://github.com/vitejs/vite).
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v5.
It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.

## What's next?

Expand Down

0 comments on commit d14751e

Please sign in to comment.