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

[WIP][docs] Add migration for v6 #42242

Draft
wants to merge 6 commits into
base: next
Choose a base branch
from

Conversation

siriwatknp
Copy link
Member

@siriwatknp siriwatknp commented May 14, 2024

Blocked by:

  • CSS theme variables docs
  • Codemod for deprecating system props (this could be useful)
  • Decide on the minimum React & TypeScript version

@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
Comment on lines 100 to 106
### `components` and `componentsProps`

<!-- TODO: add info and codemod instruction -->

### Component style overrides

<!-- TODO: add info and codemod instruction -->
Copy link
Member Author

Choose a reason for hiding this comment

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

@DiegoAndai Need your help on these sections.

@mui-bot
Copy link

mui-bot commented May 14, 2024

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 4379480

<!-- Add minimum React & TypeScript version -->

## New features and improvements

Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
### Apply styles utility
<!-- theme.applyStyles -->

The Grid v2 is now becoming the default Grid component. Check out the [migration guide](/material-ui/migration/migration-grid-v2/) to see the differences and improvements.

## Deprecations

Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
### ListItemSecondaryAction

@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

Apart from the support for Pigment CSS, the v6 release provides a stable API for adopting CSS variables which open more customization possibilities and offers a more enjoyable developer experience.

Additionally, the v6 release does not include any breaking changes. Some APIs are deprecated to bring more consistent developer experience which are easily migrated using our codemod.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Additionally, the v6 release does not include any breaking changes. Some APIs are deprecated to bring more consistent developer experience which are easily migrated using our codemod.
Additionally, the v6 release does not include any breaking changes, apart from the browser support & node.js version bump. Some APIs are deprecated to bring more consistent developer experience which are easily migrated using our codemod.

Maybe to make sure we are not setting wrong expectations.


<!-- TODO: add codemod instruction -->

## Pigment CSS integration
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Pigment CSS integration
## Pigment CSS integration (optional)

To make sure people know that they don't need to do this right away.

Copy link
Member

@mnajdova mnajdova May 27, 2024

Choose a reason for hiding this comment

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

Additional thing, we decided to keep in emotion the current overrides precendence (base styles vs variants), but change it in Pigment CSS. We need to add section on this and maybe troubleshooting guide if the styles differ.

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation on hold There is a blocker, we need to wait PR: out-of-date The pull request has merge conflicts and can't be merged
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

None yet

4 participants