fix(Form): fix onChange type allowing strictly typed setState #4280
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the Form component’s onChange prop type to support strictly typed state setters. The changes include:
- Updating the onChange prop signature in Form.tsx to use a new generic type M instead of V.
- Adding a test in FormSpec.tsx that demonstrates using a strictly typed setState function as the onChange callback.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Form/Form.tsx | Updated the onChange prop signature to use generic type M for better TypeScript compatibility. |
| src/Form/test/FormSpec.tsx | Added a test case verifying that a strictly typed setState can be passed to onChange without TypeScript errors. |
Comments suppressed due to low confidence (1)
src/Form/Form.tsx:102
- [nitpick] Consider renaming the generic parameter 'M' to a more descriptive name (e.g. 'FormValue') to improve clarity for API consumers.
onChange?: (formValue: M, event?: React.SyntheticEvent) => void;
simonguo
reviewed
May 12, 2025
| @@ -99,7 +99,7 @@ export interface FormProps<V = Record<string, any>, M = any, E = { [P in keyof V | |||
| /** | |||
| * Callback fired when data changing | |||
| */ | |||
| onChange?: (formValue: V, event?: React.SyntheticEvent) => void; | |||
| onChange?: (formValue: M, event?: React.SyntheticEvent) => void; | |||
There was a problem hiding this comment.
FormProps<V = Record<string, any>, M = any, E = { [P in keyof V]?: M }>
Hi @nandobutzke, for FormProps, V, M, and E respectively represent Value, Message, and Error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the onChange prop type in the Form component by replacing the previous V = Record<string, any> constraint with a more flexible generic type M.
The goal is to allow the use of strongly-typed state management functions (e.g., setState from useState) without triggering TypeScript type errors.
Under the previous typing, TypeScript raised an error when attempting to pass a setState function directly to onChange with a strictly typed formValue, like:
Related issue: #4154