feat(useForm): improve type parameter specification to useForm #6568
+51
−4
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: d0ce6ee The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for refine-doc-live-previews ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
BatuhanW
requested changes
Dec 16, 2024
Comment on lines
+32
to
+33
| const FormVariablesSymbol = Symbol("FormVariables"); | ||
| const SubmissionVariablesSymbol = Symbol("SubmissionVariables"); |
There was a problem hiding this comment.
here we use Symbol for FormVariables and SubmissionVariables to ensure uniqueness and avoid conflicting with the basic TVariables shape. as Ali mentioned here .
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.
PR Checklist
Please check if your PR fulfills the following requirements:
Bugs / Features
What is the current behavior?
The
useFormhook uses a single type parameter for both the form structure and the data submitted to the API. This causes type conflicts when trying to map form data into the structure needed for the API . As a result, developers encounter type errors when attempting to submit transformed data.What is the new behavior?
After the changes, the
useFormhook introduces an additional type parameter for submission data . This separates the form structure type from the submission type .onFinishfunction correctly expects the SubmissionData type instead of the form structure type. allowing developers to easily map and submit the data without running into type issues.fixes #6137
Notes for reviewers
The
onValidfunction is wrapped inonValidWrapperto address a TypeScript error where the form data (TVariables) does not match the expected structure foronValid. This results in a type conflict, so use type casting (variables as unknown as ExtractFormVariables<TVariables>) to ensure the correct form data type is passed toonValid. This resolves the error and ensures type safety during form submission.