@mxenabled/mxui 2.0.0-alpha.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -26,3 +26,35 @@ Follow the setup instructions found in
26
26
 
27
27
  Teams are currently adding components as needed, so the list in storybook right now is what has been built so far.
28
28
 
29
+ ## Upgrading from 1.x to 2.x
30
+ This major change introcuces a number of breaking changes due to dependency upgrades for React 19 and MUI 7. It also
31
+ includes removal of deprected components and theme values.
32
+
33
+ - React has been upgraded to version 19.
34
+ - See https://react.dev/blog/2024/04/25/react-19-upgrade-guide for more details.
35
+ - MUI has been upgraded to version 7.
36
+ - See https://mui.com/material-ui/migration/upgrade-to-v6/ for changes from 5 to 6.
37
+ - See https://mui.com/material-ui/migration/upgrade-to-v7/ for changes from 6 to 7.
38
+ - MUI-X has been upgraded to version 8.
39
+ - See https://mui.com/x/migration/migration-pickers-v7/ for Date picker changes
40
+ - See https://mui.com/x/migration/migration-data-grid-v7/ for Data Grid changes
41
+ - See https://mui.com/x/migration/migration-charts-v7/ for Chart changes
42
+ - Vite has been upgraded to version 7.
43
+ - See https://vite.dev/guide/migration.html for more details.
44
+ - Storybook has been upgraded to version 9.
45
+ - See https://storybook.js.org/docs/releases/migration-guide for more details
46
+ - `TokenProvider` and it's dependency `@mxenabled/mx-design-tokens` has been removed.
47
+ - The palette color `border` has been removed. Utilize `neutral`, `grey` or `divider` instead.
48
+ - The palette color properties for `lighter` & `darker` have been removed. Utilize `light` & `dark` instead.
49
+ - Custom Typography variants have been removed. Use the standard MUI variants instead.
50
+ - H1 -> h1
51
+ - H2 -> h2
52
+ - H3 -> h3
53
+ - Body -> body1
54
+ - Small -> body2
55
+ - XSmall -> caption
56
+ - Tiny -> tiny
57
+ - Button -> button
58
+ - Paragraph -> subtitle1
59
+ - ParagraphSmall -> subtitle2
60
+ - Deprecated icons have been removed. Use Material Symbol icons via the `Icon` component or directly from the MX-Icons package instead.