[core] Remove `withTheme` from `@material-ui/core` by mnajdova · Pull Request #26051 · mui/material-ui

mnajdova · 2021-04-29T12:45:13Z

The withTheme utility has been removed from the @material-ui/core/styles package. You can use the @material-ui/styles/withTheme instead. Make sure to add a ThemeProvider at the root of your application, as the defaultTheme is no longer available. If you are using this utility together with @material-ui/core, it's recommended you use the ThemeProvider from @material-ui/core/styles instead.

 import * as React from 'react';
-import { withTheme } from '@material-ui/core/styles';
+import { withTheme } from '@material-ui/styles';
+import { createTheme, ThemeProvider } from '@material-ui/core/styles';
  
+const theme = createTheme();
 const MyComponent = withTheme(({ theme }) => <div>{props.theme.direction}</div>);

 function App(props) {
-  return <MyComponent />;
+  return <ThemeProvider theme={theme}><MyComponent {...props} /></ThemeProvider>;
 }

One of the PRs that is necessary for removing @material-ui/styles as a dependency of @material-ui/core.

mui-pr-bot · 2021-04-29T12:47:05Z

Details of bundle changes

Generated by 🚫 dangerJS against 03ab006

mnajdova · 2021-04-29T13:32:47Z

packages/material-ui/test/typescript/styles.spec.tsx

 // @ts-expect-error
 const t5 = createTheme().spacing(1, 2, 3, 4, 5);

-// withTheme


There are tests for this in the @material-ui/styles package.

docs/src/pages/guides/migration-v4/migration-v4.md

docs/src/pages/styles/basics/basics.md

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

eps1lon · 2021-04-29T15:08:44Z

Did we intend to keep withTheme at all considering useTheme exists?

oliviertassinari · 2021-04-29T15:24:47Z

I was wondering too. It makes sense for the legacy code that can't be migrated to hooks, no preferences.

mnajdova · 2021-04-29T15:46:45Z

I wasn't thinking too much about it to be honest, I am just trying to break the dependencies to @material-ui/styles at this stage.

oliviertassinari · 2021-04-29T18:22:44Z

@mnajdova I think that we need to resolve the question of Sebastian. I see two cases based on the answer:

If we estimate that it's still too early to drop the HOC API, then it seems that the best course is to follow what we do with useTheme().
If we estimate that it's time to introduce a breaking change and drop withTheme for v5 users (it wasn't planned in [RFC] Material-UI v5 🚀 #20012 but why not), then I think that the current state of the PR is OK.

docs/src/pages/guides/migration-v4/migration-v4.md

eps1lon · 2021-04-29T20:44:09Z

Isn't it just a prop-injector that injects useTheme? That seems trivial enough to fork if you really need it. And in turn we can cut down in shipped code.

mnajdova · 2021-04-30T11:56:50Z

@mnajdova I think that we need to resolve the question of Sebastian. I see two cases based on the answer:

If we estimate that it's still too early to drop the HOC API, then it seems that the best course is to follow what we do with useTheme().

If we estimate that it's time to introduce a breaking change and drop withTheme for v5 users (it wasn't planned in [RFC] Material-UI v5 🚀 #20012 but why not), then I think that the current state of the PR is OK.

Let's go with option 2. I wouldn't drop anything from @material-ui/styles, as we are anyway going to deprecate that package, so I don't think it's worth doing too many changes there. If you disagree, we can go trough everything exported from @material-ui/styles and see whether we can drop some things.

oliviertassinari · 2021-04-30T12:13:04Z

@mnajdova Happy with option 2. The only reason I raised 1 is because of https://styled-components.com/docs/api#withtheme and https://emotion.sh/docs/theming#withthemecomponent-reactcomponenttype-reactcomponenttype.

init

bf048a9

mnajdova marked this pull request as draft April 29, 2021 12:45

prettier

da8ead3

remove withTheme tests from core

ebcb73c

mnajdova commented Apr 29, 2021

View reviewed changes

mnajdova marked this pull request as ready for review April 29, 2021 14:26

mnajdova requested review from eps1lon and oliviertassinari April 29, 2021 14:26

oliviertassinari reviewed Apr 29, 2021

View reviewed changes

mnajdova and others added 10 commits April 29, 2021 16:49

Update docs/src/pages/guides/migration-v4/migration-v4.md

e06cba1

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/guides/migration-v4/migration-v4.md

a1e3190

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/guides/migration-v4/migration-v4.md

7e7c9ee

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/guides/migration-v4/migration-v4.md

d14d56f

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/guides/migration-v4/migration-v4.md

5a2b099

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/guides/migration-v4/migration-v4.md

9b43ea5

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/styles/basics/basics.md

efa0893

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/styles/basics/basics.md

296a97f

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

Update docs/src/pages/styles/basics/basics.md

26ea283

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>

fix intends

489f06c

mnajdova requested a review from oliviertassinari April 29, 2021 18:17

oliviertassinari reviewed Apr 29, 2021

View reviewed changes

docs/src/pages/guides/migration-v4/migration-v4.md Outdated Show resolved Hide resolved

eps1lon approved these changes Apr 29, 2021

View reviewed changes

removed empty spacings

03ab006

mnajdova requested a review from oliviertassinari April 30, 2021 14:52

mnajdova merged commit f738e41 into mui:next Apr 30, 2021

mnajdova mentioned this pull request Jul 9, 2021

[docs] withTheme is missing #27199

Closed

2 tasks

oliviertassinari modified the milestones: v5, v5-beta Aug 17, 2021

oliviertassinari mentioned this pull request Aug 17, 2021

Deprecation warnings for v5 #22074

Closed

42 tasks

Uh oh!

Conversation

mnajdova commented Apr 29, 2021 • edited by oliviertassinari Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mui-pr-bot commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mnajdova Apr 29, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eps1lon commented Apr 29, 2021

Uh oh!

oliviertassinari commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mnajdova commented Apr 29, 2021

Uh oh!

oliviertassinari commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

eps1lon commented Apr 29, 2021

Uh oh!

mnajdova commented Apr 30, 2021

Uh oh!

oliviertassinari commented Apr 30, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mnajdova commented Apr 29, 2021 •

edited by oliviertassinari

Loading

mui-pr-bot commented Apr 29, 2021 •

edited

Loading

oliviertassinari commented Apr 29, 2021 •

edited

Loading

oliviertassinari commented Apr 29, 2021 •

edited

Loading