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

[material-ui][docs] Add first batch of v6 migration #42242

Merged
merged 24 commits into from
Jun 25, 2024
Merged

[material-ui][docs] Add first batch of v6 migration #42242

merged 24 commits into from
Jun 25, 2024

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp commented May 14, 2024 •
edited
Loading

Preview: https://deploy-preview-42242--material-ui.netlify.app/material-ui/migration/migrating-to-v6/

Out of scope

  • Pigment CSS migration (likely to be added after beta release)

@siriwatknp siriwatknp added the docs Improvements or additions to the documentation label May 14, 2024
@siriwatknp siriwatknp changed the title [docs] Add migration for v6 [WIP][docs] Add migration for v6 May 14, 2024
@siriwatknp siriwatknp added the on hold There is a blocker, we need to wait label May 14, 2024
@mui-bot
Copy link

mui-bot commented May 14, 2024 •
edited
Loading

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against bfaa89b

@siriwatknp siriwatknp added this to the Material UI: v6 milestone May 16, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 17, 2024
@DiegoAndai
Copy link
Member

Hey @siriwatknp! I merged #42194. I'll complete the deprecations section as soon as possible.

@DiegoAndai DiegoAndai self-assigned this May 24, 2024
@github-actions github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged and removed PR: out-of-date The pull request has merge conflicts and can't be merged labels May 28, 2024
@mnajdova
Copy link
Member

mnajdova commented Jun 5, 2024

Decide on the minimum React & TypeScript version

On React, we decided on React 17

@DiegoAndai
Merge branch 'next' into docs/migration-v6
9991f8f 
Signed-off-by: Diego Andai <diego@mui.com>
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 5, 2024
@DiegoAndai
Copy link
Member

@siriwatknp I updated the PR after some breaking changes were added to the migration guide in other PRs. I haven't forgotten about adding the components and componentsProps to the deprecation section 😅 I just haven't had time yet, but I'll get to it.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 10, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 11, 2024
@siriwatknp siriwatknp changed the title [WIP][docs] Add migration for v6 [docs] Add first batch of v6 migration Jun 11, 2024
@siriwatknp
Copy link
Member Author

@danilo-leal @samuelsycamore I think this is ready as the first batch of the migration guide.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 14, 2024
danilo-leal
danilo-leal reviewed Jun 14, 2024
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few notes! I'm looking forward to seeing what Sam thinks of them!

docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md
### UMD bundle was removed

To align with React 19's removal of UMD builds, Material UI has also removed its UMD bundle.
This results in a reduction of the `@mui/material` package size by 2.5MB or 25% of the total package size.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we should mention this in the "why you should migrate" section — will propose something

docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 17, 2024
danilo-leal
danilo-leal reviewed Jun 17, 2024
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great to me! Will let Sam give the final approval 🤙

docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
docs/data/material/migration/migrating-to-v6/migrating-to-v6.md

This reduces the API surface and lets you define variants in other slots of the component.

## Pigment CSS integration (optional)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note so we put this at the top (even if we're still building the section)

docs/data/material/migration/migrating-to-v6/migrating-to-v6.md Outdated Show resolved Hide resolved
@siriwatknp @danilo-leal
Apply suggestions from code review
555cdf4 
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 23, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 25, 2024
@siriwatknp siriwatknp enabled auto-merge (squash) June 25, 2024 08:57
@siriwatknp siriwatknp merged commit 37e9dee into mui:next Jun 25, 2024
19 checks passed
@samuelsycamore
Copy link
Member

samuelsycamore commented Jun 27, 2024 •
edited
Loading

I missed the chance to review but this is looking great! Nice job on the migration doc!

@DiegoAndai
Copy link
Member

DiegoAndai commented Jun 27, 2024 •
edited
Loading

@samuelsycamore I think we can/should review the whole migration doc structure and writing before the stable release. When all content is ready. This way, we avoid spamming you with notifications.

@samuelsycamore
Copy link
Member

I appreciate that @DiegoAndai ! I will be most useful in this process as an alpha tester and copyeditor, so it does make the most sense to loop me in at the very end. 👍

joserodolfofreitas pushed a commit to joserodolfofreitas/material-ui that referenced this pull request Jul 29, 2024
@siriwatknp @joserodolfofreitas
[material-ui][docs] Add first batch of v6 migration (mui#42242)
544d5ea
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mnajdova mnajdova mnajdova left review comments

@danilo-leal danilo-leal danilo-leal left review comments

@DiegoAndai DiegoAndai DiegoAndai approved these changes

@samuelsycamore samuelsycamore Awaiting requested review from samuelsycamore

Assignees

@DiegoAndai DiegoAndai

Labels
docs Improvements or additions to the documentation package: material-ui Specific to @mui/material v6.x migration
Projects
Material UI
Status: Done
Milestone
Material UI: v6
Development

Successfully merging this pull request may close these issues.
6 participants
@siriwatknp @mui-bot @DiegoAndai @mnajdova @samuelsycamore @danilo-leal