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

Migrate to MUI 5 #279

Open
45 of 48 tasks
doniyor2109 opened this issue Jan 3, 2022 · 0 comments
Open
45 of 48 tasks

Migrate to MUI 5 #279

doniyor2109 opened this issue Jan 3, 2022 · 0 comments

Comments

@doniyor2109
Copy link
Member

doniyor2109 commented Jan 3, 2022

Material UI library recently has released new version 5. It includes many breaking changes and rebranding.
This issue describes what is the plan for the migration and used as tracking progress of the migration as well.

Upgrade Plan
The new version of MUI has many breaking changes. In order to not block the current version it is better to migrate to MUI gradually.

Here is list that we should follow while upgrading:

  • We use separate branch for migration under mui5. Please create PRs targeting this branch.
  • Each component should be upgraded individually and we should preserve old component as well in order to compare changes.
  • Every components for MUI v5 should be located under v5 folder. Just copy component from /src folder and paste under src/v5 folder.
  • Tests each new and old components both with unit tests and regression tests (regression tests are not implemented yet)
  • MUI uses emotion as a main style engine. Our current implementation uses JSS and styled-components together. As we have used styled-components heavily on projects, we will use styled-components as a main engine. Migration from styled-components to Emotion should be easier as they use same API under the hood and it will be as a separate issue.
  • Follow MUI guidelines for migration mui.com/guides/migration-v4
  • Document breaking changes needed to be done on product level. (Add needed codemods as well)

Todos

Module List

Breaking Changes

Most of the components will work. However some components need to be updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant