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

[material-ui][Typography] Color prop check for primitive type #39071

Merged
merged 8 commits into from
Oct 5, 2023
Merged
14 changes: 14 additions & 0 deletions packages/mui-material/src/Typography/Typography.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,20 @@ describe('<Typography />', () => {
});
});

describe('prop: color', () => {
it('should check for invalid color value', () => {
const msg =
'MUI: The value found in theme for prop: "background" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".';
expect(() => {
render(
<Typography variant="h6" color="background">
Hello
</Typography>,
);
}).toWarnDev([msg, msg]);
});
});

it('combines system properties with the sx prop', () => {
const { container } = render(<Typography mt={2} mr={1} sx={{ marginRight: 5, mb: 2 }} />);

Expand Down
14 changes: 10 additions & 4 deletions packages/mui-system/src/palette.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,16 @@ const theme = {

describe('palette', () => {
it('should treat grey as CSS color', () => {
const output = palette({
theme,
backgroundColor: 'grey',
});
let output;
expect(() => {
output = palette({
theme,
backgroundColor: 'grey',
});
}).toWarnDev(
'MUI: The value found in theme for prop: "grey" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".',
);

expect(output).to.deep.equal({
backgroundColor: 'grey',
});
Expand Down
8 changes: 8 additions & 0 deletions packages/mui-system/src/style.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ export function getStyleValue(themeMapping, transform, propValueFinal, userValue
value = getPath(themeMapping, propValueFinal) || userValue;
}

if (typeof value === 'object') {
if (process.env.NODE_ENV !== 'production') {
console.warn(
`MUI: The value found in theme for prop: "${propValueFinal}" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".`,
);
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Please also set the userValue to value here like you were doing last time. If a proper value is not found in theme, it should just use whatever user provided in prop.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, it was removed on purpose because there are cases when value could be an object such as Typography theme key body1 or h1 which is assigned as an object through handlebreakpoints. So, I think just warning the user for possible mistake is enough. If my point is unclear kindly refer to this test case

}

if (transform) {
value = transform(value, userValue, themeMapping);
}
Expand Down
58 changes: 57 additions & 1 deletion packages/mui-system/src/style.test.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { expect } from 'chai';
import style from './style';
import style, { getStyleValue } from './style';

describe('style', () => {
const bgcolor = style({
Expand Down Expand Up @@ -258,4 +258,60 @@ describe('style', () => {
});
});
});
describe('getStyleValue', () => {
it('should warn on acceptable object', () => {
const round = (value) => Math.round(value * 1e5) / 1e5;
let output;

expect(() => {
output = getStyleValue(
{
body1: {
fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
fontSize: '1rem',
letterSpacing: `${round(0.15 / 16)}em`,
fontWeight: 400,
lineHeight: 1.5,
},
},
null,
'body1',
);
}).toWarnDev(
'MUI: The value found in theme for prop: "body1" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".',
);

expect(output).to.deep.equal({
fontFamily: '"Roboto", "Helvetica", "Arial", sans-serif',
fontSize: '1rem',
letterSpacing: `${round(0.15 / 16)}em`,
fontWeight: 400,
lineHeight: 1.5,
});
});

it('should warn on unacceptable object', () => {
const theme = {
palette: {
grey: { 100: '#f5f5f5' },
},
};

const paletteTransform = (value, userValue) => {
if (userValue === 'grey') {
return userValue;
}
return value;
};
let output;

expect(() => {
output = getStyleValue(theme.palette, paletteTransform, 'grey');
}).toWarnDev(
'MUI: The value found in theme for prop: "grey" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".',
);

expect(output).to.be.equal('grey');
});
});
});
15 changes: 11 additions & 4 deletions packages/mui-system/src/styleFunctionSx/styleFunctionSx.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,17 @@ describe('styleFunctionSx', () => {
});

it('resolves system typography', () => {
const result = styleFunctionSx({
theme,
sx: { typography: ['body2', 'body1'] },
});
let result;

expect(() => {
result = styleFunctionSx({
theme,
sx: { typography: ['body2', 'body1'] },
});
}).toWarnDev([
'MUI: The value found in theme for prop: "body2" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".',
'MUI: The value found in theme for prop: "body1" is an [Object] instead of string or number. Check if you forgot to add the correct dotted notation, eg, "background.paper" instead of "background".',
]);

expect(result).to.deep.equal({
'@media (min-width:0px)': {
Expand Down