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

Unknown props: do not warn on React components. #4084

Merged
merged 6 commits into from
Jul 11, 2023
Merged
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
2 changes: 1 addition & 1 deletion packages/styled-components/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "styled-components",
"version": "6.0.3",
"version": "6.0.4",
"description": "CSS for the <Component> Age. Style components your way with speed, strong typing, and flexibility.",
"types": "dist/index.d.ts",
"main": "dist/styled-components.cjs.js",
Expand Down
4 changes: 3 additions & 1 deletion packages/styled-components/src/models/StyledComponent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,9 @@ function useStyledComponentImpl<Props extends object>(
!shouldForwardProp &&
process.env.NODE_ENV === 'development' &&
!isPropValid(key) &&
!seenUnknownProps.has(key)
!seenUnknownProps.has(key) &&
// Only warn on DOM Element.
domElements.has(elementToBeCreated as any)
) {
seenUnknownProps.add(key);
console.warn(
Expand Down
19 changes: 19 additions & 0 deletions packages/styled-components/src/test/props.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -266,5 +266,24 @@ describe('props', () => {
expect(console.warn).toHaveBeenCalledWith(expect.stringContaining('filterThis'));
process.env.NODE_ENV = originalEnv;
});

it('do not warn in development mode when shouldForwardProp is not provided for an unknown prop on React component', () => {
let originalEnv = process.env.NODE_ENV;
process.env.NODE_ENV = 'development';

jest.spyOn(console, 'warn').mockImplementation(() => {});

const Comp = styled(({ className, myLabel }: { className?: string; myLabel: string }) => (
<span className={className}>{myLabel}</span>
))`
color: red;
`;

TestRenderer.create(<Comp myLabel="My label" />);

expect(console.warn).not.toHaveBeenCalledWith(expect.stringContaining('myLabel'));
expect(console.warn).toHaveBeenCalledTimes(0);
process.env.NODE_ENV = originalEnv;
});
});
});
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -9084,7 +9084,7 @@ style-loader@^3.3.1:
supports-color "^5.5.0"

"styled-components@link:packages/styled-components":
version "6.0.2"
version "6.0.4"
dependencies:
"@babel/cli" "^7.21.0"
"@babel/core" "^7.21.0"
Expand Down