Skip to content

[theme] Warn when palette structure is wrong #20253

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
merged 3 commits into from
Mar 24, 2020
Merged

[theme] Warn when palette structure is wrong #20253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6792548
[theme] Warn when palette structure is wrong
oliviertassinari Mar 23, 2020
afaa5de
sebastian review
oliviertassinari Mar 23, 2020
6b4f52c
second review
oliviertassinari Mar 23, 2020
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
49 changes: 32 additions & 17 deletions packages/material-ui/src/styles/createPalette.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,6 @@ export default function createPalette(palette) {
// Bootstrap: https://github.com/twbs/bootstrap/blob/1d6e3710dd447de1a200f29e8fa521f8a0908f70/scss/_functions.scss#L59
// and material-components-web https://github.com/material-components/material-components-web/blob/ac46b8863c4dab9fc22c4c662dc6bd1b65dd652f/packages/mdc-theme/_functions.scss#L54
function getContrastText(background) {
if (!background) {
throw new TypeError(
`Material-UI: missing background argument in getContrastText(${background}).`,
);
}

const contrastText =
getContrastRatio(background, dark.text.primary) >= contrastThreshold
? dark.text.primary
Expand All @@ -159,21 +153,42 @@ export default function createPalette(palette) {
return contrastText;
}

function augmentColor(color, mainShade = 500, lightShade = 300, darkShade = 700) {
const augmentColor = (color, mainShade = 500, lightShade = 300, darkShade = 700) => {
color = { ...color };
if (!color.main && color[mainShade]) {
color.main = color[mainShade];
}

if (process.env.NODE_ENV !== 'production') {
if (!color.main) {
throw new Error(
[
'Material-UI: the color provided to augmentColor(color) is invalid.',
`The color object needs to have a \`main\` property or a \`${mainShade}\` property.`,
].join('\n'),
);
}
if (!color.main) {
throw new Error(
[
'Material-UI: the color provided to augmentColor(color) is invalid.',
`The color object needs to have a \`main\` property or a \`${mainShade}\` property.`,
].join('\n'),
);
}

if (typeof color.main !== 'string') {
throw new Error(
[
'Material-UI: the color provided to augmentColor(color) is invalid.',
`\`color.main\` should be a string, but \`${JSON.stringify(
color.main,
)}\` was provided instead.`,
'',
'Did you intend to use one of the following approaches?',
'',
'import { green } from "@material-ui/core/colors";',
'',
'const theme1 = createMuiTheme({ palette: {',
' primary: green,',
'} });',
'',
'const theme2 = createMuiTheme({ palette: {',
' primary: { main: green[500] },',
'} });',
].join('\n'),
);
}

addLightOrDark(color, 'light', lightShade, tonalOffset);
Expand All @@ -183,7 +198,7 @@ export default function createPalette(palette) {
}

return color;
}
};

const types = { dark, light };

Expand Down
71 changes: 29 additions & 42 deletions packages/material-ui/src/styles/createPalette.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,6 @@ import { darken, lighten } from './colorManipulator';
import createPalette, { dark, light } from './createPalette';

describe('createPalette()', () => {
beforeEach(() => {
consoleErrorMock.spy();
});

afterEach(() => {
consoleErrorMock.reset();
});

it('should create a palette with a rich color object', () => {
const palette = createPalette({
primary: deepOrange,
Expand Down Expand Up @@ -85,26 +77,11 @@ describe('createPalette()', () => {
pink.A400,
);
expect(palette.text, 'should use dark theme text').to.equal(dark.text);
expect(consoleErrorMock.callCount()).to.equal(0);
});

it('logs an error when an invalid type is specified', () => {
createPalette({ type: 'foo' });
expect(consoleErrorMock.callCount()).to.equal(1);
expect(consoleErrorMock.messages()[0]).to.match(
/Material-UI: the palette type `foo` is not supported/,
);
});

describe('augmentColor', () => {
const palette = createPalette({});

it('should throw when the input is invalid', () => {
expect(() => {
palette.augmentColor({});
}).to.throw(/The color object needs to have a/);
});

it('should accept a color', () => {
const color1 = palette.augmentColor(indigo);
expect(color1).to.deep.include({
Expand Down Expand Up @@ -135,20 +112,37 @@ describe('createPalette()', () => {
});
});

describe('getContrastText', () => {
it('throws an exception with a falsy argument', () => {
const { getContrastText } = createPalette({});
it('should create a palette with unique object references', () => {
const redPalette = createPalette({ background: { paper: 'red' } });
const bluePalette = createPalette({ background: { paper: 'blue' } });
expect(redPalette).to.not.equal(bluePalette);
expect(redPalette.background).to.not.equal(bluePalette.background);
});

describe('warnings', () => {
beforeEach(() => {
consoleErrorMock.spy();
});

[
[undefined, 'missing background argument in getContrastText(undefined)'],
[null, 'missing background argument in getContrastText(null)'],
['', 'missing background argument in getContrastText()'],
[0, 'missing background argument in getContrastText(0)'],
].forEach((testEntry) => {
const [argument, errorMessage] = testEntry;
afterEach(() => {
consoleErrorMock.reset();
});

expect(() => getContrastText(argument), errorMessage).to.throw();
});
it('throws an exception when an invalid type is specified', () => {
createPalette({ type: 'foo' });
expect(consoleErrorMock.callCount()).to.equal(1);
expect(consoleErrorMock.messages()[0]).to.include(
'Material-UI: the palette type `foo` is not supported',
);
});

it('throws an exception when a wrong color is provided', () => {
expect(() => createPalette({ primary: '#fff' })).to.throw(
'The color object needs to have a `main` property or a `500` property.',
);
expect(() => createPalette({ primary: { main: { foo: 'bar' } } })).to.throw(
'`color.main` should be a string, but `{"foo":"bar"}` was provided instead.',
);
});

it('logs an error when the contrast ratio does not reach AA', () => {
Expand All @@ -164,11 +158,4 @@ describe('createPalette()', () => {
);
});
});

it('should create a palette with unique object references', () => {
const redPalette = createPalette({ background: { paper: 'red' } });
const bluePalette = createPalette({ background: { paper: 'blue' } });
expect(redPalette).to.not.equal(bluePalette);
expect(redPalette.background).to.not.equal(bluePalette.background);
});
});