Skip to content

[theme] Do not create channel tokens for custom colors when nativeColor is used #47765

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

Merged
ZeeshanTamboli merged 8 commits into from
Mar 30, 2026
Merged

[theme] Do not create channel tokens for custom colors when nativeColor is used #47765

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cf69ce8
Do not create channel tokens for custom colors when nativeColor is used
ZeeshanTamboli Feb 14, 2026
2b116a7
prettier
ZeeshanTamboli Feb 14, 2026
1e37e86
Add comment
ZeeshanTamboli Feb 14, 2026
db27d51
Merge branch 'master' into theme-do-not-throw-error-for-custom-colors…
ZeeshanTamboli Mar 30, 2026
08c8bf2
Apply suggestion from @siriwatknp
ZeeshanTamboli Mar 30, 2026
27f0d7f
Apply suggestion from @siriwatknp
ZeeshanTamboli Mar 30, 2026
0b916d2
Merge branch 'theme-do-not-throw-error-for-custom-colors-issue-47740'…
ZeeshanTamboli Mar 30, 2026
98087bb
Merge branch 'master' into theme-do-not-throw-error-for-custom-colors…
ZeeshanTamboli Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/mui-material/src/styles/createTheme.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -781,5 +781,20 @@ describe('createTheme', () => {
'color-mix(in oklch, hsl(0 0% 100%), #000 20%)',
);
});

it('should not warn about channel token if nativeColor is used and custom palette colors are provided', () => {
expect(() =>
createTheme({
cssVariables: { nativeColor: true },
palette: {
divider: 'var(--mui-palette-divider)',
background: {
default: 'var(--mui-palette-background-default)',
paper: 'var(--mui-palette-background-paper)',
},
},
}),
).not.toWarnDev();
});
});
});
19 changes: 11 additions & 8 deletions packages/mui-material/src/styles/createThemeWithVars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,23 +550,26 @@ export default function createThemeWithVars(options = {}, ...args) {
setColor(palette.Tooltip, 'bg', colorMix(safeAlpha, palette.grey[700], 0.92));
}

// MUI X - DataGrid needs this token.
setColorChannel(palette.background, 'default');
// Do not create channel tokens when nativeColor is used.
Comment thread
ZeeshanTamboli marked this conversation as resolved.
Outdated
if (!nativeColor) {
// MUI X - DataGrid needs this token.
Comment thread
ZeeshanTamboli marked this conversation as resolved.
Outdated
setColorChannel(palette.background, 'default');
Comment thread
ZeeshanTamboli marked this conversation as resolved.

// added for consistency with the `background.default` token
setColorChannel(palette.background, 'paper');
// added for consistency with the `background.default` token
setColorChannel(palette.background, 'paper');

setColorChannel(palette.common, 'background');
setColorChannel(palette.common, 'onBackground');
setColorChannel(palette.common, 'background');
setColorChannel(palette.common, 'onBackground');

setColorChannel(palette, 'divider');
setColorChannel(palette, 'divider');
}

Object.keys(palette).forEach((color) => {
const colors = palette[color];

// The default palettes (primary, secondary, error, info, success, and warning) errors are handled by the above `createTheme(...)`.

if (color !== 'tonalOffset' && colors && typeof colors === 'object') {
if (color !== 'tonalOffset' && !nativeColor && colors && typeof colors === 'object') {
// Silent the error for custom palettes.
if (colors.main) {
setColor(palette[color], 'mainChannel', safeColorChannel(toRgb(colors.main)));
Expand Down
Loading