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.

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

[theme] Warn when palette structure is wrong #20253

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 1 commit
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
43 changes: 32 additions & 11 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,48 @@ 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(
if (!color.main) {
if (process.env.NODE_ENV !== 'production') {
console.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'),
);
}
color.main = indigo[500];
}

if (typeof color.main !== 'string') {
if (process.env.NODE_ENV !== 'production') {
console.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 intent to do one of the followings?',
'',
'import { green } from "@material-ui/core/colors";',
'',
'const theme1 = createMuiTheme({ palette: {',
' primary: green,',
'} });',
'',
'const theme2 = createMuiTheme({ palette: {',
' primary: { main: green[500] },',
'} });',
].join('\n'),
);
}
color.main = indigo[500];
}

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

return color;
}
};

const types = { dark, light };

Expand Down
6 changes: 0 additions & 6 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 @@ -99,12 +99,6 @@ describe('createPalette()', () => {
describe('augmentColor', () => {
const palette = createPalette({});

it('should throw when the input is invalid', () => {
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
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