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.

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

Extend documentation with section on new transformed values type TTransformedValues of useForm and SubmitHandler #1082

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Extend documentation with section on new transformed values type TTransformedValues of useForm and SubmitHandler #1082

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4b9d5d
Added explanation for transformed data type and extended listing
maurer2 Aug 18, 2024
0e18a7f
Extended description
maurer2 Aug 20, 2024
ddc2e23
Fix merge conflict
maurer2 Oct 24, 2024
aba29e6
Merge branch 'master' into master
maurer2 Oct 24, 2024
fbc2e37
Merge branch 'react-hook-form:master' into master
maurer2 Oct 27, 2024
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: 4 additions & 0 deletions src/content/ts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ export default function App() {

## \</> SubmitHandler {#SubmitHandler}

This type describes the shape of the data that is passed to the submit handler. By default the type used in the angle brackets should be the same as the type used for `useForm` ({#UseFormReturn}). When form data is transformed into a different shape via resolvers, a different type that describes the new shape of the form data should be used instead.

```typescript copy sandbox="https://codesandbox.io/s/react-hook-form-handlesubmit-ts-v7-z9z0g"
import React from "react"
import { useForm, SubmitHandler } from "react-hook-form"
Expand Down Expand Up @@ -124,6 +126,8 @@ export default function App() {

## \</> UseFormReturn {#UseFormReturn}

The first type used in the angle brackets describes the shape of the form data. It should be the same type used in the submit handler function ({#SubmitHandler}) unless the form data is transformed via resolvers. In that case an additional type can be used as a third parameter inside the angle brackets, which describes the shape of the form data after transformation.

<TabGroup buttonLabels={["Type", "Code Example"]}>

```typescript copy
Expand Down