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.

Sign up for GitHub

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

Jump to bottom

[system] Add migration guide link to @mui/styles pages #43833

Merged
merged 6 commits into from
Sep 25, 2024
Merged

[system] Add migration guide link to @mui/styles pages #43833

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5268c8e
update deprecation message
samuelsycamore Sep 20, 2024
302041a
make it less redundant
samuelsycamore Sep 20, 2024
573a967
remove final line break
samuelsycamore Sep 20, 2024
67476fd
link to migrate from jss doc
samuelsycamore Sep 23, 2024
c5c98f6
pnpm dedupe
samuelsycamore Sep 23, 2024
b5e1ffa
merge master
samuelsycamore Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/data/styles/advanced/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@

:::error
`@mui/styles` was deprecated with the release of MUI Core v5 in late 2021.
It depended on [JSS](https://cssinjs.org/) as a styling solution, which is no longer used in `@mui/material`.

`@mui/styles` is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18, and it will not be updated.
It is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18+, and it will not be updated.

Check warning on line 7 in docs/data/styles/advanced/advanced.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/styles/advanced/advanced.md", "range": {"start": {"line": 7, "column": 113}}}, "severity": "WARNING"}

This documentation remains here for those working on legacy projects, but we **strongly discourage** you from using `@mui/styles` when creating a new app with Material UI—you _will_ face unresolvable dependency issues.

Please use [`@mui/system`](/system/getting-started/) instead.
See the [v5 migration docs](/material-ui/migration/migration-v4/) for details on how to migrate away from `@mui/styles`.
:::

## Theming
Expand Down
5 changes: 2 additions & 3 deletions docs/data/styles/api/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@

:::error
`@mui/styles` was deprecated with the release of MUI Core v5 in late 2021.
It depended on [JSS](https://cssinjs.org/) as a styling solution, which is no longer used in `@mui/material`.

`@mui/styles` is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18, and it will not be updated.
It is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18+, and it will not be updated.

Check warning on line 11 in docs/data/styles/api/api.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/styles/api/api.md", "range": {"start": {"line": 11, "column": 113}}}, "severity": "WARNING"}

This documentation remains here for those working on legacy projects, but we **strongly discourage** you from using `@mui/styles` when creating a new app with Material UI—you _will_ face unresolvable dependency issues.

Please use [`@mui/system`](/system/getting-started/) instead.
See the [v5 migration docs](/material-ui/migration/migration-v4/) for details on how to migrate away from `@mui/styles`.
:::

## `createGenerateClassName([options]) => class name generator`
Expand Down
5 changes: 2 additions & 3 deletions docs/data/styles/basics/basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,12 @@

:::error
`@mui/styles` was deprecated with the release of MUI Core v5 in late 2021.
It depended on [JSS](https://cssinjs.org/) as a styling solution, which is no longer used in `@mui/material`.

`@mui/styles` is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18, and it will not be updated.
It is not compatible with [React.StrictMode](https://react.dev/reference/react/StrictMode) or React 18+, and it will not be updated.

Check warning on line 7 in docs/data/styles/basics/basics.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/styles/basics/basics.md", "range": {"start": {"line": 7, "column": 113}}}, "severity": "WARNING"}

This documentation remains here for those working on legacy projects, but we **strongly discourage** you from using `@mui/styles` when creating a new app with Material UI—you _will_ face unresolvable dependency issues.

Please use [`@mui/system`](/system/getting-started/) instead.
See the [v5 migration docs](/material-ui/migration/migration-v4/) for details on how to migrate away from `@mui/styles`.
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved
:::

## Installation
Expand Down
Loading