resetField: (name: string, options?: Record<string, boolean | any>) => void
Reset an individual field state.
Props
After invoke this function.
isValid
form state will be reevaluated.isDirty
form state will be reevaluated.
ResetField
has the ability to retain field state. Here are the options you may want to use:
Name | Type | Description | |
---|---|---|---|
name | string | registered field name. | |
options | keepError | boolean | When set to |
keepDirty | boolean | When set to | |
keepTouched | boolean | When set to | |
defaultValue | unknown | When this value is not provided, field will be revert back to it's defaultValue. When this value is provided:
|
Rules
name need to match registered field name.
register('test'); resetField('test'); // ✅ register input and resetField works resetField('non-existent-name'); // ❌ failed by input not found
Examples
import * as React from "react"; import { useForm } from "react-hook-form"; export default function App() { const { register, resetField, formState: { isDirty, isValid } } = useForm({ mode: "onChange", defaultValues: { firstName: "" } }); const handleClick = () => resetField("firstName"); return ( <form> <input {...register("firstName", { required: true })} /> <p>{isDirty && "dirty"}</p> <p>{isValid && "valid"}</p> <button type="button" onClick={handleClick}> Reset </button> </form> ); }
Video
The following video tutorial demonstrates resetField
API.
Thank you for your support
If you find React Hook Form to be useful in your project, please consider to star and support it.