Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.59 KB

README.md

File metadata and controls

55 lines (40 loc) · 1.59 KB

🏁 Final Form Set Field Touched

NPM Version NPM Downloads Build Status codecov.io styled with prettier

Mutator for setting a field as "touched" in 🏁 Final Form.


Installation

npm install --save final-form-set-field-touched

or

yarn add final-form-set-field-touched

Usage

import { createForm } from 'final-form'
import setFieldTouched from 'final-form-set-field-touched'

// Create Form
const form = createForm({
  mutators: { setFieldTouched },
  onSubmit
})

form.mutators.setFieldTouched('firstName', true)

form.registerField(
  'firstName',
  fieldState => {
    const { touched } = fieldState // true
  },
  {
    // ...other subscription items
    touched: true
  }
)

Mutator

form.mutators.setFieldTouched(name: string, touched: boolean) => void

Sets the specified field's touched flag to the boolean value provided.