Skip to content

fix(TS): make wrapper allow a simple function comp #966

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 7 commits into from
Sep 27, 2021
Merged

fix(TS): make wrapper allow a simple function comp #966

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
23d498f
fix(TS): make wrapper allow a simple function comp
kentcdodds Sep 24, 2021
064f26f
chore: fix TS syntax
kentcdodds Sep 24, 2021
2010eb1
chore: format with prettier
kentcdodds Sep 24, 2021
ffa2221
Test linked issue
eps1lon Sep 27, 2021
dc03098
Fix type-test
eps1lon Sep 27, 2021
f23919d
git hygene
eps1lon Sep 27, 2021
206757b
Merge branch 'main' into pr/wrapper-types
eps1lon Sep 27, 2021
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
4 changes: 3 additions & 1 deletion types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ export interface RenderOptions<
*
* @see https://testing-library.com/docs/react-testing-library/api/#wrapper
*/
wrapper?: React.ComponentType
wrapper?:
| React.ComponentType
| ((props: {children: React.ReactNode}) => JSX.Element)
Copy link
Member

Choose a reason for hiding this comment

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

Let me add a type test for this because the fix is simpler I believe.

Copy link
Member

@eps1lon eps1lon Sep 27, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Implicit children strikes again (DefinitelyTyped/DefinitelyTyped#34237):

React.ComponentType includes React.FunctionComponent which means the accepted props are { children?: React.ReactNode }. However, our Wrapper only accepts { children: React.ReactElement } props. So we could render <Wrapper>Some Child</Wrapper> which may not be implemented by the custom Wrapper component because now it receives { children: string }.

The proposed fix would not have fixed the linked issue (npm typecheck fails on ffa2221). dc03098 fixes the linked issue.

}

type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
Expand Down