feat(useForm): export granular setData types and introduce SetDataAction<TForm> #2356
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
…n for useForm This commit introduces and exports the following new types to improve type inference and reusability for the useForm hook: - SetDataByObject<TForm> - SetDataByMethod<TForm> - SetDataByKeyValuePair<TForm> - SetDataAction<TForm> (a union of the above three) These types are especially useful when passing setData as a prop or context value, enabling consumers to type it properly. Also updated InertiaFormProps<TForm> to use the new SetDataAction<TForm> type. This enhances developer experience when working with useForm in TypeScript-heavy applications.
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.
Summary
This PR adds exportable type definitions for the different
setDatafunction signatures used in theuseFormhook:SetDataByObject<TForm>SetDataByMethod<TForm>SetDataByKeyValuePair<TForm>SetDataAction<TForm>(union of the three above)It also updates the
InertiaFormProps<TForm>interface to use the newSetDataAction<TForm>type.Motivation
When using
useForm, developers often need to pass thesetDatamethod as a prop or context value. However, the composite type ofsetDatawas not previously exported, making it difficult to provide proper type annotations. Exporting these types improves type safety and developer experience in TypeScript-heavy applications.What’s Changed
SetDataByObject,SetDataByMethod,SetDataByKeyValuePairtypesSetDataAction<TForm>as a union of the aboveInertiaFormProps<TForm>to useSetDataAction<TForm>Notes
useFormremains intact