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

Add warning about css shorthand properties collision(#6348) #13860

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions packages/react-dom/src/__tests__/ReactDOMComponent-test.js
Expand Up @@ -2698,5 +2698,34 @@ describe('ReactDOMComponent', () => {
ReactDOM.render(<Component />, container);
expect(typeof container.onclick).not.toBe('function');
});

it('should warn about css shorthand properties collision', () => {
const container = document.createElement('div');
const oldStyle = {
background: 'url(http://example.org/image/a.jpg) no-repeat center',
backgroundSize: '150px',
backgroundColor: 'red',
};

ReactDOM.render(<div style={oldStyle} />, container);
const stubStyle = container.firstChild.style;

expect(stubStyle.background).toEqual(
'url(http://example.org/image/a.jpg) no-repeat center',
);
expect(stubStyle.backgroundSize).toEqual('150px');
expect(stubStyle.backgroundColor).toEqual('red');

const newStyle = {
background: 'url(http://example.org/image/b.jpg) no-repeat center',
};

expect(() =>
ReactDOM.render(<div style={newStyle} />, container),
).toWarnDev(
'Warning: Css shorthand properties collision:' +
' background properties are being overridden. (backgroundSize,backgroundColor)',
);
});
});
});
21 changes: 21 additions & 0 deletions packages/react-dom/src/client/ReactDOMComponent.js
Expand Up @@ -13,6 +13,7 @@ import {registrationNameModules} from 'events/EventPluginRegistry';
import warning from 'shared/warning';
import {canUseDOM} from 'shared/ExecutionEnvironment';
import warningWithoutStack from 'shared/warningWithoutStack';
import {shorthandProperties} from '../shared/CSSProperty';

import * as DOMPropertyOperations from './DOMPropertyOperations';
import * as ReactDOMInput from './ReactDOMInput';
Expand Down Expand Up @@ -709,6 +710,26 @@ export function diffProperties(
if (!styleUpdates) {
styleUpdates = {};
}
// Check shorthand properties collision
if (__DEV__) {
if (shorthandProperties.hasOwnProperty(styleName)) {
const propertyGroup = shorthandProperties[styleName];
const overriddenProperties = [];
for (let lastStyleName in lastProp) {
if (propertyGroup.includes(lastStyleName)) {
overriddenProperties.push(lastStyleName);
}
}
if (overriddenProperties.length > 0) {
warning(
false,
'Css shorthand properties collision: %s properties are being overridden. (%s)',
styleName,
overriddenProperties,
);
}
}
}
styleUpdates[styleName] = nextProp[styleName];
}
}
Expand Down
12 changes: 12 additions & 0 deletions packages/react-dom/src/shared/CSSProperty.js
Expand Up @@ -55,6 +55,18 @@ export const isUnitlessNumber = {
strokeWidth: true,
};

export const shorthandProperties = {
background: [
'backgroundAttachment',
'backgroundClip',
'backgroundColor',
'backgroundImage',
'backgroundOrigin',
'backgroundPosition',
'backgroundRepeat',
'backgroundSize',
],
};
/**
* @param {string} prefix vendor-specific prefix, eg: Webkit
* @param {string} key style name, eg: transitionDuration
Expand Down