@temp-mui/codemod
v5.15.14
Published
Codemod scripts for MUI.
Downloads
2
Maintainers
Readme
@temp-mui/codemod
Codemod scripts for Material UI, Base UI, MUI System, Joy UI.
This repository contains a collection of codemod scripts based for use with jscodeshift that help update the APIs. Some of the codemods also run postcss plugins to update CSS files.
Setup & run
npx @temp-mui/codemod@latest <codemod> <paths...>
Applies a `@temp-mui/codemod` to the specified paths
Positionals:
codemod The name of the codemod [string]
paths Paths forwarded to `jscodeshift` [string]
Options:
--version Show version number [boolean]
--help Show help [boolean]
--dry dry run (no changes are made to files)
[boolean] [default: false]
--parser which parser for jscodeshift to use.
[string] [default: 'tsx']
--print print transformed files to stdout, useful for development
[boolean] [default: false]
--jscodeshift [string] [default: false]
Examples:
npx @temp-mui/codemod@latest v4.0.0/theme-spacing-api src
npx @temp-mui/codemod@latest v5.0.0/component-rename-prop src --
--component=Grid --from=prop --to=newProp
npx @temp-mui/codemod@latest v5.0.0/preset-safe src --parser=flow
jscodeshift options
To pass more options directly to jscodeshift, use --jscodeshift="..."
. For example:
npx @temp-mui/codemod@latest --jscodeshift="--run-in-band --verbose=2"
See all available options here.
Recast Options
Options to recast's printer can be provided
through jscodeshift's printOptions
command line argument
npx @temp-mui/codemod@latest <transform> <path> --jscodeshift="--printOptions='{\"quote\":\"double\"}'"
Included scripts
Deprecations
npx @temp-mui/codemod@latest deprecations/all <path>
all
A combination of all deprecations.
accordion-props
<Accordion
- TransitionComponent={CustomTransition}
- TransitionProps={{ unmountOnExit: true }}
+ slots={{ transition: CustomTransition }}
+ slotProps={{ transition: { unmountOnExit: true } }}
/>
npx @temp-mui/codemod@latest deprecations/accordion-props <path>
accordion-summary-classes
JS transforms:
import { accordionSummaryClasses } from '@temp-mui/material/AccordionSummary';
MuiAccordionSummary: {
styleOverrides: {
root: {
- [`& .${accordionSummaryClasses.contentGutters}`]: {
+ [`&.${accordionSummaryClasses.gutters} .${accordionSummaryClasses.content}`]: {
color: 'red',
},
},
},
},
MuiAccordionSummary: {
styleOverrides: {
root: {
- '& .MuiAccordionSummary-contentGutters': {
+ '&.MuiAccordionSummary-gutters .MuiAccordionSummary-content': {
color: 'red',
},
},
},
},
CSS transforms:
-.MuiAccordionSummary-root .MuiAccordionSummary-contentGutters
+.MuiAccordionSummary-root.MuiAccordionSummary-gutters .MuiAccordionSummary-content
/>
npx @temp-mui/codemod@latest deprecations/accordion-summary-classes <path>
alert-classes
JS transforms:
import { alertClasses } from '@temp-mui/material/PaginationItem';
MuiPaginationItem: {
styleOverrides: {
root: {
- [`&.${alertClasses.standardSuccess}`]: {
+ [`&.${alertClasses.standard}.${alertClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${alertClasses.standardInfo}`]: {
+ [`&.${alertClasses.standard}.${alertClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${alertClasses.standardWarning}`]: {
+ [`&.${alertClasses.standard}.${alertClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${alertClasses.standardError}`]: {
+ [`&.${alertClasses.standard}.${alertClasses.colorError}`]: {
color: 'red',
},
- [`&.${alertClasses.outlinedSuccess}`]: {
+ [`&.${alertClasses.outlined}.${alertClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${alertClasses.outlinedInfo}`]: {
+ [`&.${alertClasses.outlined}.${alertClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${alertClasses.outlinedWarning}`]: {
+ [`&.${alertClasses.outlined}.${alertClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${alertClasses.outlinedError}`]: {
+ [`&.${alertClasses.outlined}.${alertClasses.colorError}`]: {
color: 'red',
},
- [`&.${alertClasses.filledSuccess}`]: {
+ [`&.${alertClasses.filled}.${alertClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${alertClasses.filledInfo}`]: {
+ [`&.${alertClasses.filled}.${alertClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${alertClasses.filledWarning}`]: {
+ [`&.${alertClasses.filled}.${alertClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${alertClasses.filledError}`]: {
+ [`&.${alertClasses.filled}.${alertClasses.colorError}`]: {
color: 'red',
},
},
},
},
CSS transforms:
-.MuiAlert-standardSuccess
+.MuiAlert-standard.MuiAlert-colorSuccess
-.MuiAlert-standardInfo
+.MuiAlert-standard.MuiAlert-colorInfo
-.MuiAlert-standardWarning
+.MuiAlert-standard.MuiAlert-colorWarning
-.MuiAlert-standardError
+.MuiAlert-standard.MuiAlert-colorError
-.MuiAlert-outlinedSuccess
+.MuiAlert-outlined.MuiAlert-colorSuccess
-.MuiAlert-outlinedInfo
+.MuiAlert-outlined.MuiAlert-colorInfo
-.MuiAlert-outlinedWarning
+.MuiAlert-outlined.MuiAlert-colorWarning
-.MuiAlert-outlinedError
+.MuiAlert-outlined.MuiAlert-colorError
-.MuiAlert-filledSuccess
+.MuiAlert-filled.MuiAlert-colorSuccess
-.MuiAlert-filledInfo
+.MuiAlert-filled.MuiAlert-colorInfo
-.MuiAlert-filledWarning
+.MuiAlert-filled.MuiAlert-colorWarning
-.MuiAlert-filledError
+.MuiAlert-filled.MuiAlert-colorError
npx @temp-mui/codemod@latest deprecations/alert-classes <path>
alert-props
<Alert
- components={{ CloseButton: CustomButton }}
+ slots={{ closeButton: CustomButton }}
- componentsProps={{ closeButton: { testid: 'test-id' } }}
+ slotProps={{ closeButton: { testid: 'test-id' } }}
/>
MuiAlert: {
defaultProps: {
- components: { CloseButton: CustomButton }
+ slots: { closeButton: CustomButton },
- componentsProps: { closeButton: { testid: 'test-id' }}
+ slotProps: { closeButton: { testid: 'test-id' } },
},
},
npx @temp-mui/codemod@latest deprecations/alert-props <path>
avatar-props
<Avatar
- imgProps={{
- onError: () => {},
- onLoad: () => {},
+ slotProps={{
+ img: {
+ onError: () => {},
+ onLoad: () => {},
+ }
}}
/>;
button-classes
JS transforms:
import { buttonClasses } from '@temp-mui/material/Button';
MuiButton: {
styleOverrides: {
root: {
- [`&.${buttonClasses.textInherit}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorInherit}`]: {
color: 'red',
},
- [`&.${buttonClasses.textPrimary}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${buttonClasses.textSecondary}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${buttonClasses.textSuccess}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${buttonClasses.textError}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorError}`]: {
color: 'red',
},
- [`&.${buttonClasses.textInfo}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${buttonClasses.textWarning}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedInherit}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorInherit}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedPrimary}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedSecondary}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedSuccess}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedError}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorError}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedInfo}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedWarning}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedInherit}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorInherit}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedPrimary}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedSecondary}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedSuccess}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorSuccess}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedError}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorError}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedInfo}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorInfo}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedWarning}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.colorWarning}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedSizeSmall}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.sizeSmall}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedSizeMedium}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.sizeMedium}`]: {
color: 'red',
},
- [`&.${buttonClasses.containedSizeLarge}`]: {
+ [`&.${buttonClasses.contained}.${buttonClasses.sizeLarge}`]: {
color: 'red',
},
- [`&.${buttonClasses.textSizeSmall}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.sizeSmall}`]: {
color: 'red',
},
- [`&.${buttonClasses.textSizeMedium}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.sizeMedium}`]: {
color: 'red',
},
- [`&.${buttonClasses.textSizeLarge}`]: {
+ [`&.${buttonClasses.text}.${buttonClasses.sizeLarge}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedSizeSmall}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.sizeSmall}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedSizeMedium}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.sizeMedium}`]: {
color: 'red',
},
- [`&.${buttonClasses.outlinedSizeLarge}`]: {
+ [`&.${buttonClasses.outlined}.${buttonClasses.sizeLarge}`]: {
color: 'red',
},
- [`& .${buttonClasses.iconSizeSmall}`]: {
+ [`&.${buttonClasses.sizeSmall} > .${buttonClasses.icon}`]: {
color: 'red',
},
- [`& .${buttonClasses.iconSizeMedium}`]: {
+ [`&.${buttonClasses.sizeMedium} > .${buttonClasses.icon}`]: {
color: 'red',
},
- [`& .${buttonClasses.iconSizeLarge}`]: {
+ [`&.${buttonClasses.sizeLarge} > .${buttonClasses.icon}`]: {
color: 'red',
},
},
},
},
CSS transforms:
-.MuiButton-textInherit
+.MuiButton-text.MuiButton-colorInherit
-.MuiButton-textPrimary
+.MuiButton-text.MuiButton-colorPrimary
-.MuiButton-textSecondary
+.MuiButton-text.MuiButton-colorSecondary
-.MuiButton-textSuccess
+.MuiButton-text.MuiButton-colorSuccess
-.MuiButton-textError
+.MuiButton-text.MuiButton-colorError
-.MuiButton-textInfo
+.MuiButton-text.MuiButton-colorInfo
-.MuiButton-textWarning
+.MuiButton-text.MuiButton-colorWarning
-.MuiButton-outlinedInherit
+.MuiButton-outlined.MuiButton-colorInherit
-.MuiButton-outlinedPrimary
+.MuiButton-outlined.MuiButton-colorPrimary
-.MuiButton-outlinedSecondary
+.MuiButton-outlined.MuiButton-colorSecondary
-.MuiButton-outlinedSuccess
+.MuiButton-outlined.MuiButton-colorSuccess
-.MuiButton-outlinedError
+.MuiButton-outlined.MuiButton-colorError
-.MuiButton-outlinedInfo
+.MuiButton-outlined.MuiButton-colorInfo
-.MuiButton-outlinedWarning
+.MuiButton-outlined.MuiButton-colorWarning
-.MuiButton-containedInherit
+.MuiButton-contained.MuiButton-colorInherit
-.MuiButton-containedPrimary
+.MuiButton-contained.MuiButton-colorPrimary
-.MuiButton-containedSecondary
+.MuiButton-contained.MuiButton-colorSecondary
-.MuiButton-containedSuccess
+.MuiButton-contained.MuiButton-colorSuccess
-.MuiButton-containedError
+.MuiButton-contained.MuiButton-colorError
-.MuiButton-containedInfo
+.MuiButton-contained.MuiButton-colorInfo
-.MuiButton-containedWarning
+.MuiButton-contained.MuiButton-colorWarning
-.MuiButton-textSizeSmall
+.MuiButton-text.MuiButton-sizeSmall
-.MuiButton-textSizeMedium
+.MuiButton-text.MuiButton-sizeMedium
-.MuiButton-textSizeLarge
+.MuiButton-text.MuiButton-sizeLarge
-.MuiButton-outlinedSizeSmall
+.MuiButton-outlined.MuiButton-sizeSmall
-.MuiButton-outlinedSizeMedium
+.MuiButton-outlined.MuiButton-sizeMedium
-.MuiButton-outlinedSizeLarge
+.MuiButton-outlined.MuiButton-sizeLarge
-.MuiButton-containedSizeSmall
+.MuiButton-contained.MuiButton-sizeSmall
-.MuiButton-containedSizeMedium
+.MuiButton-contained.MuiButton-sizeMedium
-.MuiButton-containedSizeLarge
+.MuiButton-contained.MuiButton-sizeLarge
-.MuiButton-root .MuiButton-iconSizeSmall
+.MuiButton-root.MuiButton-sizeSmall > .MuiButton-icon
-.MuiButton-root .MuiButton-iconSizeMedium
+.MuiButton-root.MuiButton-sizeMedium > .MuiButton-icon
-.MuiButton-root .MuiButton-iconSizeLarge
+.MuiButton-root.MuiButton-sizeLarge > .MuiButton-icon
/>
npx @temp-mui/codemod@latest deprecations/button-classes <path>
chip-classes
JS transforms:
import { chipClasses } from '@temp-mui/material/Chip';
MuiChip: {
styleOverrides: {
root: {
- [`&.${chipClasses.clickableColorPrimary}`]: {
+ [`&.${chipClasses.clickable}.${chipClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${chipClasses.clickableColorSecondary}`]: {
+ [`&.${chipClasses.clickable}.${chipClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${chipClasses.deletableColorPrimary}`]: {
+ [`&.${chipClasses.deletable}.${chipClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${chipClasses.deletableColorSecondary}`]: {
+ [`&.${chipClasses.deletable}.${chipClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${chipClasses.outlinedPrimary}`]: {
+ [`&.${chipClasses.outlined}.${chipClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${chipClasses.outlinedSecondary}`]: {
+ [`&.${chipClasses.outlined}.${chipClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${chipClasses.filledPrimary}`]: {
+ [`&.${chipClasses.filled}.${chipClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${chipClasses.filledSecondary}`]: {
+ [`&.${chipClasses.filled}.${chipClasses.colorSecondary}`]: {
color: 'red',
},
- [`& .${chipClasses.avatarSmall}`]: {
+ [`&.${chipClasses.sizeSmall} > .${chipClasses.avatar}`]: {
color: 'red',
},
- [`& .${chipClasses.avatarMedium}`]: {
+ [`&.${chipClasses.sizeMedium} > .${chipClasses.avatar}`]: {
color: 'red',
},
- [`& .${chipClasses.avatarColorPrimary}`]: {
+ [`&.${chipClasses.colorPrimary} > .${chipClasses.avatar}`]: {
color: 'red',
},
- [`& .${chipClasses.avatarColorSecondary}`]: {
+ [`&.${chipClasses.colorSecondary} > .${chipClasses.avatar}`]: {
color: 'red',
},
- [`& .${chipClasses.iconSmall}`]: {
+ [`&.${chipClasses.sizeSmall} > .${chipClasses.icon}`]: {
color: 'red',
},
- [`& .${chipClasses.iconMedium}`]: {
+ [`&.${chipClasses.sizeMedium} > .${chipClasses.icon}`]: {
color: 'red',
},
- [`& .${chipClasses.iconColorPrimary}`]: {
+ [`&.${chipClasses.colorPrimary} > .${chipClasses.icon}`]: {
color: 'red',
},
- [`& .${chipClasses.iconColorSecondary}`]: {
+ [`&.${chipClasses.colorSecondary} > .${chipClasses.icon}`]: {
color: 'red',
},
- [`& .${chipClasses.labelSmall}`]: {
+ [`&.${chipClasses.sizeSmall} > .${chipClasses.label}`]: {
color: 'red',
},
- [`& .${chipClasses.labelMedium}`]: {
+ [`&.${chipClasses.sizeMedium} > .${chipClasses.label}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconSmall}`]: {
+ [`&.${chipClasses.sizeSmall} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconMedium}`]: {
+ [`&.${chipClasses.sizeMedium} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconColorPrimary}`]: {
+ [`&.${chipClasses.colorPrimary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconColorSecondary}`]: {
+ [`&.${chipClasses.colorSecondary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconOutlinedColorPrimary}`]: {
+ [`&.${chipClasses.outlined}.${chipClasses.colorPrimary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconOutlinedColorSecondary}`]: {
+ [`&.${chipClasses.outlined}.${chipClasses.colorSecondary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconFilledColorPrimary}`]: {
+ [`&.${chipClasses.filled}.${chipClasses.colorPrimary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
- [`& .${chipClasses.deleteIconFilledColorSecondary}`]: {
+ [`&.${chipClasses.filled}.${chipClasses.colorSecondary} > .${chipClasses.deleteIcon}`]: {
color: 'red',
},
},
},
},
CSS transforms:
-.MuiChip-clickableColorPrimary
+.MuiChip-clickable.MuiChip-colorPrimary
-.MuiChip-clickableColorSecondary
+.MuiChip-clickable.MuiChip-colorSecondary
-.MuiChip-deletableColorPrimary
+.MuiChip-deletable.MuiChip-colorPrimary
-.MuiChip-deletableColorSecondary
+.MuiChip-deletable.MuiChip-colorSecondary
-.MuiChip-outlinedPrimary
+.MuiChip-outlined.MuiChip-colorPrimary
-.MuiChip-outlinedSecondary
+.MuiChip-outlined.MuiChip-colorSecondary
-.MuiChip-filledPrimary
+.MuiChip-filled.MuiChip-colorPrimary
-.MuiChip-filledSecondary
+.MuiChip-filled.MuiChip-colorSecondary
-.MuiChip-root .MuiChip-avatarSmall
+.MuiChip-root.MuiChip-sizeSmall > .MuiChip-avatar
-.MuiChip-root .MuiChip-avatarMedium
+.MuiChip-root.MuiChip-sizeMedium > .MuiChip-avatar
-.MuiChip-root .MuiChip-avatarColorPrimary
+.MuiChip-root.MuiChip-colorPrimary > .MuiChip-avatar
-.MuiChip-root .MuiChip-avatarColorSecondary
+.MuiChip-root.MuiChip-colorSecondary > .MuiChip-avatar
-.MuiChip-root .MuiChip-iconSmall
+.MuiChip-root.MuiChip-sizeSmall > .MuiChip-icon
-.MuiChip-root .MuiChip-iconMedium
+.MuiChip-root.MuiChip-sizeMedium > .MuiChip-icon
-.MuiChip-root .MuiChip-iconColorPrimary
+.MuiChip-root.MuiChip-colorPrimary > .MuiChip-icon
-.MuiChip-root .MuiChip-iconColorSecondary
+.MuiChip-root.MuiChip-colorSecondary > .MuiChip-icon
-.MuiChip-root .MuiChip-labelSmall
+.MuiChip-root.MuiChip-sizeSmall > .MuiChip-label
-.MuiChip-root .MuiChip-labelMedium
+.MuiChip-root.MuiChip-sizeMedium > .MuiChip-label
-.MuiChip-root .MuiChip-deleteIconSmall
+.MuiChip-root.MuiChip-sizeSmall > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconMedium
+.MuiChip-root.MuiChip-sizeMedium > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconColorPrimary
+.MuiChip-root.MuiChip-colorPrimary > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconColorSecondary
+.MuiChip-root.MuiChip-colorSecondary > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconOutlinedColorPrimary
+.MuiChip-root.MuiChip-outlined.MuiChip-colorPrimary > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconOutlinedColorSecondary
+.MuiChip-root.MuiChip-outlined.MuiChip-colorSecondary > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconFilledColorPrimary
+.MuiChip-root.MuiChip-filled.MuiChip-colorPrimary > .MuiChip-deleteIcon
-.MuiChip-root .MuiChip-deleteIconFilledColorSecondary
+.MuiChip-root.MuiChip-filled.MuiChip-colorSecondary > .MuiChip-deleteIcon
npx @temp-mui/codemod@latest deprecations/chip-classes <path>
divider-props
<Divider
- light
+ sx={{opacity: "0.6"}}
/>
npx @temp-mui/codemod@latest deprecations/divider-props <path>
pagination-item-classes
JS transforms:
import { paginationItemClasses } from '@temp-mui/material/PaginationItem';
MuiPaginationItem: {
styleOverrides: {
root: {
- [`&.${paginationItemClasses.textPrimary}`]: {
+ [`&.${paginationItemClasses.text}.${paginationItemClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${paginationItemClasses.textSecondary}`]: {
+ [`&.${paginationItemClasses.text}.${paginationItemClasses.colorSecondary}`]: {
color: 'red',
},
- [`&.${paginationItemClasses.outlinedPrimary}`]: {
+ [`&.${paginationItemClasses.outlined}.${paginationItemClasses.colorPrimary}`]: {
color: 'red',
},
- [`&.${paginationItemClasses.outlinedSecondary}`]: {
+ [`&.${paginationItemClasses.outlined}.${paginationItemClasses.colorSecondary}`]: {
color: 'red',
},
- '&.MuiPaginationItem-textPrimary': {
+ '&.MuiPaginationItem-text.MuiPaginationItem-colorPrimary': {
color: 'red',
},
- '&.MuiPaginationItem-textSecondary': {
+ '&.MuiPaginationItem-text.MuiPaginationItem-colorSecondary': {
color: 'red',
},
- '&.MuiPaginationItem-outlinedPrimary': {
+ '&.MuiPaginationItem-outlined.MuiPaginationItem-colorPrimary': {
color: 'red',
},
- '&.MuiPaginationItem-outlinedSecondary': {
+ '&.MuiPaginationItem-outlined.MuiPaginationItem-colorSecondary': {
color: 'red',
},
},
},
},
CSS transforms:
-.MuiPaginationItem-textPrimary
+.MuiPaginationItem-text.MuiPaginationItem-primary
-.MuiPaginationItem-textSecondary
+.MuiPaginationItem-text.MuiPaginationItem-secondary
-.MuiPaginationItem-outlinedPrimary
+.MuiPaginationItem-outlined.MuiPaginationItem-primary
-.MuiPaginationItem-outlinedSecondary
+.MuiPaginationItem-outlined.MuiPaginationItem-secondary
/>
npx @temp-mui/codemod@latest deprecations/pagination-item-classes <path>
slider-props
<Slider
- components={{ Track: CustomTrack }}
+ slots={{ track: CustomTrack }}
- componentsProps={{ track: { testid: 'test-id' } }}
+ slotProps={{ track: { testid: 'test-id' } }}
/>
MuiSlider: {
defaultProps: {
- components: { Track: CustomTrack }
+ slots: { track: CustomTrack },
- componentsProps: { track: { testid: 'test-id' }}
+ slotProps: { track: { testid: 'test-id' } },
},
},
npx @temp-mui/codemod@latest deprecations/slider-props <path>
v5.0.0
base-use-named-exports
Base UI default exports were changed to named ones. Previously we had a mix of default and named ones. This was changed to improve consistency and avoid problems some bundlers have with default exports. See https://github.com/mui/material-ui/issues/21862 for more context.
This codemod updates the import and re-export statements.
-import BaseButton from '@temp-mui/base/Button';
-export { default as BaseSlider } from '@temp-mui/base/Slider';
+import { Button as BaseButton } from '@temp-mui/base/Button';
+export { Slider as BaseSlider } from '@temp-mui/base/Slider';
npx @temp-mui/codemod@latest v5.0.0/base-use-named-exports <path>
base-remove-unstyled-suffix
The Unstyled
suffix has been removed from all Base UI component names, including names of types and other related identifiers.
-<Input component='a' href='url' />;
+<Input slots={{ root: 'a' }} href='url' />;
npx @temp-mui/codemod@latest v5.0.0/base-remove-unstyled-suffix <path>
base-remove-component-prop
Remove component
prop from all Base UI components by transferring its value into slots.root
.
This change only affects Base UI components.
-<Input component={CustomRoot} />
+<Input slots={{ root: CustomRoot }} />
npx @temp-mui/codemod@latest v5.0.0/base-remove-component-prop <path>
rename-css-variables
Updates the names of the CSS variables of the Joy UI components to adapt to the new naming standards of the CSS variables for components.
-<List sx={{ py: 'var(--List-divider-gap)' }}>
-<Switch sx={{ '--Switch-track-width': '40px' }}>
+<List sx={{ py: 'var(--ListDivider-gap)' }}>
+<Switch sx={{ '--Switch-trackWidth': '40px' }}>
npx @temp-mui/codemod@latest v5.0.0/rename-css-variables <path>
base-hook-imports
Updates the sources of the imports of the Base UI hooks to adapt to the new directories of the hooks.
-import { useBadge } from '@temp-mui/base/BadgeUnstyled';
+import useBadge from '@temp-mui/base/useBadge';
npx @temp-mui/codemod@latest v5.0.0/base-hook-imports <path>
joy-rename-classname-prefix
Renames the classname prefix from 'Joy'
to 'Mui'
for Joy UI components.
<Button
- sx={{ '& .JoyButton-root': { '& .JoyButton-button': {} } }}
+ sx={{ '& .MuiButton-root': { '& .MuiButton-button': {} } }}
/>;
npx @temp-mui/codemod@latest v5.0.0/joy-rename-classname-prefix <path>
joy-rename-row-prop
Transforms row
prop to orientation
prop across Card
, List
and RadioGroup
components.
<Card
- row
+ orientation={"horizontal"}
/>;
npx @temp-mui/codemod@latest v5.0.0/joy-rename-row-prop <path>
joy-avatar-remove-imgProps
Remove imgProps
prop by transferring its value into slotProps.img
This change only affects Joy UI Avatar component.
<Avatar
- imgProps={{ ['data-id']: 'imageId' }}
- slotProps={{ root: { ['data-id']: 'rootId' }}}
+ slotProps={{ root: { ['data-id']: 'rootId' }, img: { ['data-id']: 'imageId' } }}
/>;
npx @temp-mui/codemod@latest v5.0.0/joy-avatar-remove-imgProps <path>
joy-text-field-to-input
Replace <TextField>
with composition of Input
This change only affects Joy UI components.
-import TextField from '@temp-mui/joy/TextField';
+import FormControl from '@temp-mui/joy/FormControl';
+import FormLabel from '@temp-mui/joy/FormLabel';
+import FormHelperText from '@temp-mui/joy/FormHelperText';
+import Input from '@temp-mui/joy/Input';
-<TextField
- id="Id"
- label="Label"
- placeholder="Placeholder"
- helperText="Help!"
- name="Name"
- type="tel"
- autoComplete="on"
- autoFocus
- error
- required
- fullWidth
- defaultValue="DefaultValue"
- size="sm"
- color="primary"
- variant="outlined"
-/>
+<FormControl
+ id="Id"
+ required
+ size="sm"
+ color="primary">
+ <FormLabel>
+ Label
+ </FormLabel>
+ <JoyInput
+ placeholder="Placeholder"
+ name="Name"
+ type="tel"
+ autoComplete="on"
+ autoFocus
+ error
+ fullWidth
+ defaultValue="DefaultValue"
+ variant="outlined" />
+ <FormHelperText id="Id-helper-text">
+ Help!
+ </FormHelperText>
+</FormControl>
npx @temp-mui/codemod@latest v5.0.0/joy-text-field-to-input <path>
joy-rename-components-to-slots
Renames the components
and componentsProps
props to slots
and slotProps
, respectively.
This change only affects Joy UI components.
<Autocomplete
- components={{ listbox: CustomListbox }}
- componentsProps={{ root: { className: 'root' }, listbox: { 'data-testid': 'listbox' } }}
+ slots={{ listbox: CustomListbox }}
+ slotProps={{ root: { className: 'root' }, listbox: { 'data-testid': 'listbox' } }}
/>;
npx @temp-mui/codemod@latest v5.0.0/joy-rename-components-to-slots <path>
The associated breaking change was done in #34997.
date-pickers-moved-to-x
Rename the imports of Date and Time Pickers from @temp-mui/lab
to @temp-mui/x-date-pickers
and @temp-mui/x-date-pickers-pro
.
npx @temp-mui/codemod@latest v5.0.0/date-pickers-moved-to-x <path>
tree-view-moved-to-x
Rename the imports of Tree View from @temp-mui/lab
to @temp-mui/x-tree-view
.
npx @temp-mui/codemod@latest v5.0.0/tree-view-moved-to-x <path>
🚀 preset-safe
A combination of all important transformers for migrating v4 to v5. ⚠️ This codemod should be run only once.
npx @temp-mui/codemod@latest v5.0.0/preset-safe <path|folder>
The list includes these transformers
adapter-v4
autocomplete-rename-closeicon
autocomplete-rename-option
avatar-circle-circular
badge-overlap-value
box-borderradius-values
box-rename-css
box-rename-gap
button-color-prop
chip-variant-prop
circularprogress-variant
collapse-rename-collapsedheight
core-styles-import
create-theme
dialog-props
dialog-title-props
emotion-prepend-cache
expansion-panel-component
fab-variant
fade-rename-alpha
grid-justify-justifycontent
grid-list-component
icon-button-size
material-ui-styles
material-ui-types
modal-props
moved-lab-modules
pagination-round-circular
optimal-imports
root-ref
skeleton-variant
styled-engine-provider
table-props
tabs-scroll-buttons
textarea-minmax-rows
theme-augment
theme-breakpoints
theme-breakpoints-width
theme-options
theme-palette-mode
theme-provider
theme-spacing
theme-typography-round
transitions
use-autocomplete
use-transitionprops
with-mobile-dialog
with-width
mui-replace
adapter-v4
Imports and inserts adaptV4Theme
into createTheme
(or createMuiTheme
)
+import { adaptV4Theme } from '@material-ui/core/styles';
-createTheme({ palette: { ... }})
+createTheme(adaptV4Theme({ palette: { ... }}))
npx @temp-mui/codemod@latest v5.0.0/adapter-v4 <path>
You can find more details about this breaking change in the migration guide.
autocomplete-rename-closeicon
Renames Autocomplete
's closeIcon
prop to clearIcon
.
-<Autocomplete closeIcon={defaultClearIcon} />
+<Autocomplete clearIcon={defaultClearIcon} />
npx @temp-mui/codemod@latest v5.0.0/autocomplete-rename-closeicon <path>
You can find more details about this breaking change in the migration guide.
autocomplete-rename-option
Renames Autocomplete
's getOptionSelected
to isOptionEqualToValue
.
<Autocomplete
- getOptionSelected={(option, value) => option.title === value.title}
+ isOptionEqualToValue={(option, value) => option.title === value.title}
/>
npx @temp-mui/codemod@latest v5.0.0/autocomplete-rename-option <path>
You can find more details about this breaking change in the migration guide.
avatar-circle-circular
Updates the Avatar
's variant
value and classes
key from 'circle' to 'circular'.
-<Avatar variant="circle" />
-<Avatar classes={{ circle: 'className' }} />
+<Avatar variant="circular" />
+<Avatar classes={{ circular: 'className' }} />
npx @temp-mui/codemod@latest v5.0.0/avatar-circle-circular <path>
You can find more details about this breaking change in the migration guide.
badge-overlap-value
Renames the badge's props.
-<Badge overlap="circle">
-<Badge overlap="rectangle">
+<Badge overlap="circular">
+<Badge overlap="rectangular">
<Badge classes={{
- anchorOriginTopRightRectangle: 'className',
- anchorOriginBottomRightRectangle: 'className',
- anchorOriginTopLeftRectangle: 'className',
- anchorOriginBottomLeftRectangle: 'className',
- anchorOriginTopRightCircle: 'className',
- anchorOriginBottomRightCircle: 'className',
- anchorOriginTopLeftCircle: 'className',
+ anchorOriginTopRightRectangular: 'className',
+ anchorOriginBottomRightRectangular: 'className',
+ anchorOriginTopLeftRectangular: 'className',
+ anchorOriginBottomLeftRectangular: 'className',
+ anchorOriginTopRightCircular: 'className',
+ anchorOriginBottomRightCircular: 'className',
+ anchorOriginTopLeftCircular: 'className',
}}>
npx @temp-mui/codemod@latest v5.0.0/badge-overlap-value <path>
You can find more details about this breaking change in the migration guide.
base-rename-components-to-slots
Renames the components
and componentsProps
props to slots
and slotProps
, respectively.
Also, changes slots
' fields names to camelCase.
This change only affects Base UI components.
<BadgeUnstyled
- components={{ Root, Badge: CustomBadge }}
- componentsProps={{ root: { className: 'root' }, badge: { 'data-testid': 'badge' } }}
+ slots={{ root: Root, badge: CustomBadge }}
+ slotProps={{ root: { className: 'root' }, badge: { 'data-testid': 'badge' } }}
/>;
npx @temp-mui/codemod@latest v5.0.0/base-rename-components-to-slots <path>
The associated breaking change was done in #34693.
box-borderradius-values
Updates the Box API from separate system props to sx
.
-<Box borderRadius="borderRadius">
-<Box borderRadius={16}>
+<Box borderRadius={1}>
+<Box borderRadius="16px">
npx @temp-mui/codemod@latest v5.0.0/box-borderradius-values <path>
You can find more details about this breaking change in the migration guide.
box-rename-css
Renames the Box css
prop to sx
-<Box css={{ m: 2 }}>
+<Box sx={{ m: 2 }}>
npx @temp-mui/codemod@latest v5.0.0/box-rename-css <path>
You can find more details about this breaking change in the migration guide.
box-rename-gap
Renames the Box grid*Gap
props.
-<Box gridGap={2}>Item 3</Box>
-<Box gridColumnGap={3}>Item 4</Box>
-<Box gridRowGap={4}>Item 5</Box>
+<Box gap={2}>Item 3</Box>
+<Box columnGap={3}>Item 4</Box>
+<Box rowGap={4}>Item 5</Box>
npx @temp-mui/codemod@latest v5.0.0/box-rename-gap <path>
You can find more details about this breaking change in the migration guide.
button-color-prop
Removes the outdated color
prop values.
-<Button color="default">
+<Button>
npx @temp-mui/codemod@latest v5.0.0/button-color-prop <path>
You can find more details about this breaking change in the migration guide.
chip-variant-prop
Removes the Chip variant
prop if the value is "default"
.
-<Chip variant="default">
+<Chip>
npx @temp-mui/codemod@latest v5.0.0/chip-variant-prop <path>
You can find more details about this breaking change in the migration guide.
circularprogress-variant
Renames the CircularProgress static
variant to determinate
.
-<CircularProgress variant="static" classes={{ static: 'className' }} />
+<CircularProgress variant="determinate" classes={{ determinate: 'className' }} />
npx @temp-mui/codemod@latest v5.0.0/circularprogress-variant <path>
You can find more details about this breaking change in the migration guide.
collapse-rename-collapsedheight
Renames Collapse
's collapsedHeight
prop to collapsedSize
.
-<Collapse collapsedHeight={40} />
-<Collapse classes={{ container: 'collapse' }} />
+<Collapse collapsedSize={40} />
+<Collapse classes={{ root: 'collapse' }} />
npx @temp-mui/codemod@latest v5.0.0/collapse-rename-collapsedheight <path>
You can find more details about this breaking change in the migration guide.
component-rename-prop
A generic codemod to rename any component prop.
-<Component prop="value" />
-<Component prop />
+<Component newProp="value" />
+<Component newProp />
npx @temp-mui/codemod@latest v5.0.0/component-rename-prop <path> -- --component=Grid --from=prop --to=newProp
core-styles-import
Renames private import from core/styles/*
to core/styles
-import { darken, lighten } from '@material-ui/core/styles/colorManipulator';
+import { darken, lighten } from '@material-ui/core/styles';
npx @temp-mui/codemod@latest v5.0.0/core-styles-import <path>
create-theme
Renames the function createMuiTheme
to createTheme
-import { createMuiTheme } from '@material-ui/core/styles';
+import { createTheme } from '@material-ui/core/styles';
npx @temp-mui/codemod@latest v5.0.0/create-theme <path>
dialog-props
Remove disableBackdropClick
prop from <Dialog>
-<Dialog disableBackdropClick />
+<Dialog />
npx @temp-mui/codemod@latest v5.0.0/dialog-props <path>
You can find more details about this breaking change in the migration guide.
dialog-title-props
Remove disableTypography
prop from <DialogTitle>
-<DialogTitle disableTypography />
+<DialogTitle />
npx @temp-mui/codemod@latest v5.0.0/dialog-title-props <path>
You can find more details about this breaking change in the migration guide.
emotion-prepend-cache
Adds prepend: true
to Emotion createCache
const cache = emotionCreateCache({
key: 'css',
+ prepend: true,
});
npx @temp-mui/codemod@latest v5.0.0/create-theme <path>
expansion-panel-component
Renames ExpansionPanel*
to Accordion*
npx @temp-mui/codemod@latest v5.0.0/expansion-panel-component <path>
You can find more details about this breaking change in the migration guide.
fab-variant
-<Fab variant="round" />
+<Fab variant="circular" />
npx @temp-mui/codemod@latest v5.0.0/fab-variant <path>
You can find more details about this breaking change in the migration guide.
fade-rename-alpha
Renames the fade
style utility import and calls to alpha
.
-import { fade, lighten } from '@material-ui/core/styles';
+import { alpha, lighten } from '@material-ui/core/styles';
-const foo = fade('#aaa');
+const foo = alpha('#aaa');
npx @temp-mui/codemod@latest v5.0.0/fade-rename-alpha <path>
You can find more details about this breaking change in the migration guide.
grid-justify-justifycontent
Renames Grid
's justify
prop to justifyContent
.
-<Grid justify="left">Item</Grid>
+<Grid item justifyContent="left">Item</Grid>
npx @temp-mui/codemod@latest v5.0.0/grid-justify-justifycontent <path>
You can find more details about this breaking change in the migration guide.
grid-list-component
Renames GridList*
to ImageList*
npx @temp-mui/codemod@latest v5.0.0/grid-list-component <path>
You can find more details about this breaking change in the migration guide.
icon-button-size
Adds size="large"
if size
is not defined to get the same appearance as v4.
-<IconButton size="medium" />
-<IconButton />
+<IconButton size="medium" />
+<IconButton size="large" />
npx @temp-mui/codemod@latest v5.0.0/icon-button-size <path>
You can find more details about this breaking change in the migration guide.
jss-to-styled
Replace JSS styling with makeStyles
or withStyles
to styled
API.
import Typography from '@material-ui/core/Typography';
-import makeStyles from '@material-ui/styles/makeStyles';
+import { styled } from '@material-ui/core/styles';
-const useStyles = makeStyles((theme) => ({
- root: {
- display: 'flex',
- alignItems: 'center',
- backgroundColor: theme.palette.primary.main
- },
- cta: {
- borderRadius: theme.shape.radius
- },
- content: {
- color: theme.palette.common.white,
- fontSize: 16,
- lineHeight: 1.7
- },
-}))
+const PREFIX = 'MyCard';
+const classes = {
+ root: `${PREFIX}-root`,
+ cta: `${PREFIX}-cta`,
+ content: `${PREFIX}-content`,
+}
+const Root = styled('div')((theme) => ({
+ [`&.${classes.root}`]: {
+ display: 'flex',
+ alignItems: 'center',
+ backgroundColor: theme.palette.primary.main
+ },
+ [`& .${classes.cta}`]: {
+ borderRadius: theme.shape.radius
+ },
+ [`& .${classes.content}`]: {
+ color: theme.palette.common.white,
+ fontSize: 16,
+ lineHeight: 1.7
+ },
+}))
export const MyCard = () => {
const classes = useStyles();
return (
- <div className={classes.root}>
+ <Root className={classes.root}>
<Typography className={classes.content}>...</Typography>
<Button className={classes.cta}>Go</Button>
- </div>
+ </Root>
)
}
npx @temp-mui/codemod@latest v5.0.0/jss-to-styled <path>
You can find more details about this breaking change in the migration guide.
Note: This approach converts the first element in the return statement into styled component but also increases CSS specificity to override nested children. This codemod should be adopted after handling all breaking changes, check out the migration documentation.
jss-to-tss-react
Migrate JSS styling with makeStyles
or withStyles
to the corresponding tss-react
API.
-import clsx from 'clsx';
-import {makeStyles, createStyles} from '@material-ui/core/styles';
+import { makeStyles } from 'tss-react/mui';
-const useStyles = makeStyles((theme) => createStyles<
- 'root' | 'small' | 'child', {color: 'primary' | 'secondary', padding: number}
->
-({
- root: ({color, padding}) => ({
+const useStyles = makeStyles<{color: 'primary' | 'secondary', padding: number}, 'child' | 'small'>({name: 'App'})((theme, { color, padding }, classes) => ({
+ root: {
padding: padding,
- '&:hover $child': {
+ [`&:hover .${classes.child}`]: {
backgroundColor: theme.palette[color].main,
}
- }),
+ },
small: {},
child: {
border: '1px solid black',
height: 50,
- '&$small': {
+ [`&.${classes.small}`]: {
height: 30
}
}
-}), {name: 'App'});
+}));
function App({classes: classesProp}: {classes?: any}) {
- const classes = useStyles({color: 'primary', padding: 30, classes: classesProp});
+ const { classes, cx } = useStyles({
+ color: 'primary',
+ padding: 30
+ }, {
+ props: {
+ classes: classesProp
+ }
+ });
return (
<div className={classes.root}>
<div className={classes.child}>
The Background take the primary theme color when the mouse hovers the parent.
</div>
- <div className={clsx(classes.child, classes.small)}>
+ <div className={cx(classes.child, classes.small)}>
The Background take the primary theme color when the mouse hovers the parent.
I am smaller than the other child.
</div>
</div>
);
}
export default App;
npx @temp-mui/codemod@latest v5.0.0/jss-to-tss-react <path>
The following scenarios are not currently handled by this codemod and will be marked with a "TODO jss-to-tss-react codemod" comment:
- If the hook returned by
makeStyles
(for exampleuseStyles
) is exported and used in another file, the usages in other files will not be converted. - Arrow functions as the value for a CSS prop will not be converted. Arrow functions are supported at the rule level, though with some caveats listed below.
- In order for arrow functions at the rule level to be converted, the parameter must use object
destructuring (for example
root: ({color, padding}) => (...)
). If the parameter is not destructured (for exampleroot: (props) => (...)
), it will not be converted. - If an arrow function at the rule level contains a code block (that is contains an explicit
return
statement) rather than just an object expression, it will not be converted.
You can find more details about migrating from JSS to tss-react in the migration guide.
link-underline-hover
Apply underline="hover"
to <Link />
that does not define underline
prop (to get the same behavior as in v4).
-<Link />
+<Link underline="hover" />
npx @temp-mui/codemod@latest v5.0.0/link-underline-hover <path>
You can find more details about this breaking change in the migration guide.
material-ui-styles
Moves JSS imports to @material-ui/styles
-import {
- createGenerateClassName,
- createStyles,
- jssPreset,
- makeStyles,
- ServerStyleSheets,
- useThemeVariants,
- withStyles,
- withTheme,
- ThemeProvider,
- styled,
- getStylesCreator,
- mergeClasses,
-} from '@material-ui/core/styles';
+import { ThemeProvider, styled } from '@material-ui/core/styles';
+import createGenerateClassName from '@material-ui/styles/createGenerateClassName';
+import createStyles from '@material-ui/styles/createStyles';
+import jssPreset from '@material-ui/styles/jssPreset';
+import makeStyles from '@material-ui/styles/makeStyles';
+import ServerStyleSheets from '@material-ui/styles/ServerStyleSheets';
+import useThemeVariants from '@material-ui/styles/useThemeVariants';
+import withStyles from '@material-ui/styles/withStyles';
+import withTheme from '@material-ui/styles/withTheme';
+import getStylesCreator from '@material-ui/styles/getStylesCreator';
import mergeClasses from '@material-ui/styles/mergeClasses';
npx @temp-mui/codemod@latest v5.0.0/material-ui-styles <path>
material-ui-types
Renames Omit
import from @material-ui/types
to DistributiveOmit
-import { Omit } from '@material-ui/types';
+import { DistributiveOmit } from '@material-ui/types';
npx @temp-mui/codemod@latest v5.0.0/material-ui-types <path>
You can find more details about this breaking change in the migration guide.
modal-props
Removes disableBackdropClick
and onEscapeKeyDown
from <Modal>
<Modal
- disableBackdropClick
- onEscapeKeyDown={handleEscapeKeyDown}
/>
npx @temp-mui/codemod@latest v5.0.0/modal-props <path>
You can find more details about this breaking change in the migration guide.
moved-lab-modules
Updates all imports for @material-ui/lab
components that have moved to @material-ui/core
.
-import Skeleton from '@material-ui/lab/Skeleton';
+import Skeleton from '@material-ui/core/Skeleton';
or
-import { SpeedDial } from '@material-ui/lab';
+import { SpeedDial } from '@material-ui/core';
npx @temp-mui/codemod@latest v5.0.0/moved-lab-modules <path>
You can find more details about this breaking change in the migration guide.
pagination-round-circular
Renames Pagination*
's shape
values from 'round' to 'circular'.
-<Pagination shape="round" />
-<PaginationItem shape="round" />
+<Pagination shape="circular" />
+<PaginationItem shape="circular" />
npx @temp-mui/codemod@latest v5.0.0/pagination-round-circular <path>
You can find more details about this breaking change in the migration guide.
optimal-imports
Fix private import paths.
-import red from '@material-ui/core/colors/red';
-import createTheme from '@material-ui/core/styles/createTheme';
+import { red } from '@material-ui/core/colors';
+import { createTheme } from '@material-ui/core/styles';
npx @temp-mui/codemod@latest v5.0.0/optimal-imports <path>
root-ref
Removes RootRef
from the codebase.
npx @temp-mui/codemod@latest v5.0.0/root-ref <path>
You can find more details about this breaking change in the migration guide.
skeleton-variant
-<Skeleton variant="circle" />
-<Skeleton variant="rect" />
+<Skeleton variant="circular" />
+<Skeleton variant="rectangular" />
npx @temp-mui/codemod@latest v5.0.0/skeleton-variant <path>
You can find more details about this breaking change in the migration guide.
styled-engine-provider
Applies StyledEngineProvider
to the files that contains ThemeProvider
.
npx @temp-mui/codemod@latest v5.0.0/styled-engine-provider <path>
You can find more details about this breaking change in the migration guide.
table-props
Renames props in Table*
components.
-<>
- <TablePagination onChangeRowsPerPage={() => {}} onChangePage={() => {}} />
- <TablePagination classes={{ input: 'foo' }} />
- <Table padding="default" />
- <TableCell padding="default" />
-</>
+<>
+ <TablePagination onRowsPerPageChange={() => {}} onPageChange={() => {}} />
+ <TablePagination classes={{ select: 'foo' }} />
+ <Table padding="normal" />
+ <TableCell padding="normal" />
+</>
npx @temp-mui/codemod@latest v5.0.0/table-props <path>
You can find more details about this breaking change in the migration guide.
tabs-scroll-buttons
Renames the Tabs
's scrollButtons
prop values.
-<Tabs scrollButtons="on" />
-<Tabs scrollButtons="desktop" />
-<Tabs scrollButtons="off" />
+<Tabs scrollButtons allowScrollButtonsMobile />
+<Tabs scrollButtons />
+<Tabs scrollButtons={false} />
npx @temp-mui/codemod@latest v5.0.0/tabs-scroll-buttons <path>
You can find more details about this breaking change in the migration guide.
textarea-minmax-rows
Renames TextField
's rows props.
-<TextField rowsMin={3} rowsMax={6} />
-<TextareaAutosize rows={2} />
-<TextareaAutosize rowsMin={3} rowsMax={6} />
+<TextField minRows={3} maxRows={6} />
+<TextareaAutosize minRows={2} />
+<TextareaAutosize minRows={3} maxRows={6} />
npx @temp-mui/codemod@latest v5.0.0/textarea-minmax-rows <path>
You can find more details about this breaking change in the migration guide.
theme-augment
Adds DefaultTheme
module augmentation to TypeScript projects.
npx @temp-mui/codemod@latest v5.0.0/theme-augment <path>
You can find more details about this breaking change in the migration guide.
theme-breakpoints
Updates breakpoint values to match new logic. ⚠️ This mod is not idempotent, it should be run only once.
-theme.breakpoints.down('sm')
-theme.breakpoints.between('sm', 'md')
+theme.breakpoints.down('md')
+theme.breakpoints.between('sm', 'lg')
npx @temp-mui/codemod@latest v5.0.0/theme-breakpoints <path>
You can find more details about this breaking change in the migration guide.
theme-breakpoints-width
Renames theme.breakpoints.width('md')
to theme.breakpoints.values.md
.
npx @temp-mui/codemod@latest v5.0.0/theme-breakpoints-width <path>
You can find more details about this breaking change in the migration guide.
theme-options
-import { ThemeOptions } from '@material-ui/core';
+import { DeprecatedThemeOptions } from '@material-ui/core';
npx @temp-mui/codemod@latest v5.0.0/theme-options <path>
theme-palette-mode
Renames type
to mode
.
{
palette: {
- type: 'dark',
+ mode: 'dark',
},
}
-theme.palette.type === 'dark'
+theme.palette.mode === 'dark'
npx @temp-mui/codemod@latest v5.0.0/theme-palette-mode <path>
You can find more details about this breaking change in the migration guide.
theme-provider
Renames MuiThemeProvider
to ThemeProvider
.
npx @temp-mui/codemod@latest v5.0.0/theme-provider <path>
You can find more details about this breaking change in the migration guide.
theme-spacing
Removes the 'px' suffix from some template strings.
-`${theme.spacing(2)}px`
-`${theme.spacing(2)}px ${theme.spacing(4)}px`
+`${theme.spacing(2)}`
+`${theme.spacing(2)} ${theme.spacing(4)}`
npx @temp-mui/codemod@latest v5.0.0/theme-spacing <path>
You can find more details about this breaking change in the migration guide.
theme-typography-round
Renames theme.typography.round($number)
to Math.round($number * 1e5) / 1e5
.
-`${theme.typography.round($number)}`
+`${Math.round($number * 1e5) / 1e5}`
npx @temp-mui/codemod@latest v5.0.0/theme-typography-round <path>
You can find more details about this breaking change in the migration guide.
top-level-imports
Converts all @temp-mui/material
submodule imports to the root module:
-import List from '@temp-mui/material/List';
-import Grid from '@temp-mui/material/Grid';
+import { List, Grid } from '@temp-mui/material';
npx @temp-mui/codemod@latest v5.0.0/top-level-imports <path>
Head to https://mui.com/guides/minimizing-bundle-size/ to understand when it's useful.
transitions
Renames import transitions
to createTransitions
npx @temp-mui/codemod@latest v5.0.0/transitions <path>
use-autocomplete
Renames useAutocomplete
related import from lab to core
-import useAutocomplete from '@material-ui/lab/useAutocomplete';
+import useAutocomplete from '@material-ui/core/useAutocomplete';
npx @temp-mui/codemod@latest v5.0.0/use-autocomplete <path>
use-transitionprops
Updates Dialog, Menu, Popover, and Snackbar to use the TransitionProps
prop to replace the onEnter*
and onExit*
props.
<Dialog
- onEnter={onEnter}
- onEntered={onEntered}
- onEntering={onEntering}
- onExit={onExit}
- onExited={onExited}
- onExiting={onExiting}
+ TransitionProps={{
+ onEnter,
+ onEntered,
+ onEntering,
+ onExit,
+ onExited,
+ onExiting,
+ }}
/>
npx @temp-mui/codemod@latest v5.0.0/use-transitionprops <path>
You can find more details about this breaking change in the migration guide.
variant-prop
Don't run this codemod if you already set
variant
tooutlined
orfilled
in theme default props.
Adds the TextField, Select, and FormControl's variant="standard"
prop when variant
is undefined.
The diff should look like this:
-<TextField value="Standard" />
+<TextField value="Standard" variant="standard" />
-<Select value="Standard" />
+<Select value="Standard" variant="standard" />
-<FormControl value="Standard" />
+<FormControl value="Standard" variant="standard" />
npx @temp-mui/codemod@latest v5.0.0/variant-prop <path>
with-mobile-dialog
Removes imported withMobileDialog
, and inserts hardcoded version to prevent application crash.
-import withMobileDialog from '@material-ui/core/withMobileDialog';
+// FIXME checkout https://mui.com/material-ui/migration/v5-component-changes/#dialog
+const withMobileDialog = () => (WrappedComponent) => (props) => <WrappedComponent {...props} width="lg" fullScreen={false} />;
npx @temp-mui/codemod@latest v5.0.0/with-mobile-dialog <path>
You can find more details about this breaking change in the migration guide.
with-width
Removes withWidth
import, and inserts hardcoded version to prevent application crash.
-import withWidth from '@material-ui/core/withWidth';
+// FIXME checkout https://mui.com/components/use-media-query/#migrating-from-withwidth
+const withWidth = () => (WrappedComponent) => (props) => <WrappedComponent {...props} width="xs" />;
npx @temp-mui/codemod@latest v5.0.0/with-width <path>
You can find more details about this breaking change in the migration guide.
mui-replace
Replace every occurrence of material-ui
related package with the new package names (listed below) except these packages (@material-ui/pickers
, @material-ui/data-grid
, @material-ui/x-grid
& @material-ui/x-grid-data-generator
). More details about why package names are changed
Material Design components
-import Alert from '@material-ui/core/Alert';
+import Alert from '@temp-mui/material/Alert';
JSS styles package
-import { makeStyles } from '@material-ui/styles';
+import { makeStyles } from '@temp-mui/styles';
System package
-import { SxProps } from '@material-ui/system';
+import { SxProps } from '@temp-mui/system';
Utilities package
-import { deepmerge } from '@material-ui/utils';
+import { deepmerge } from '@temp-mui/utils';
Lab
-import Mansory from '@material-ui/lab/Mansory';
+import Mansory from '@temp-mui/lab/Mansory';
Dependencies
// package.json
-"@material-ui/core": "next",
-"@material-ui/icons": "next",
-"@material-ui/lab": "next",
-"@material-ui/unstyled": "next",
-"@material-ui/styled-engine-sc": "next",
+"@temp-mui/material": "next",
+"@temp-mui/icons-material": "next",
+"@temp-mui/lab": "next",
+"@temp-mui/base": "next",
+"@temp-mui/styled-engine-sc": "next",
npx @temp-mui/codemod@latest v5.0.0/mui-replace <path>
You can find more details about this breaking change in the migration guide.
v4.0.0
theme-spacing-api
Updates the theme-spacing-api
from theme.spacing.unit x
to theme.spacing(x)
.
The diff should look like this:
-const spacing = theme.spacing.unit;
+const spacing = theme.spacing(1);
npx @temp-mui/codemod@latest v4.0.0/theme-spacing-api <path>
This codemod tries to perform a basic expression simplification which can be improved for expressions that use more than one operation.
-const spacing = theme.spacing.unit / 5;
+const spacing = theme.spacing(0.2);
// Limitation
-const spacing = theme.spacing.unit * 5 * 5;
+const spacing = theme.spacing(5) * 5;
optimal-imports
Converts all @material-ui/core
imports more than 1 level deep to the optimal form for tree shaking:
-import withStyles from '@material-ui/core/styles/withStyles';
-import createTheme from '@material-ui/core/styles/createTheme';
+import { withStyles, createTheme } from '@material-ui/core/styles';
npx @temp-mui/codemod@latest v4.0.0/optimal-imports <path>
Head to https://mui.com/guides/minimizing-bundle-size/ to understand when it's useful.
top-level-imports
Converts all @material-ui/core
submodule imports to the root module:
-import List from '@material-ui/core/List';
-import { withStyles } from '@material-ui/core/styles';
+import { List, withStyles }