https://github.com/final-form/final-form-set-field-data

Mutator for setting arbitrary metadata on fields in 🏁 Final Form
https://github.com/final-form/final-form-set-field-data

Last synced: 12 months ago
JSON representation

Mutator for setting arbitrary metadata on fields in 🏁 Final Form

• Host: GitHub
• URL: https://github.com/final-form/final-form-set-field-data
• Owner: final-form
• License: mit
• Created: 2017-12-05T10:37:06.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T19:40:09.000Z (over 3 years ago)
• Last Synced: 2025-06-10T15:30:19.268Z (about 1 year ago)
• Language: JavaScript
• Size: 679 KB
• Stars: 39
• Watchers: 2
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# 🏁 Final Form Set Field Data

[![NPM Version](https://img.shields.io/npm/v/final-form-set-field-data.svg?style=flat)](https://www.npmjs.com/package/final-form-set-field-data)

[![NPM Downloads](https://img.shields.io/npm/dm/final-form-set-field-data.svg?style=flat)](https://www.npmjs.com/package/final-form-set-field-data)

[![Build Status](https://travis-ci.org/final-form/final-form-set-field-data.svg?branch=master)](https://travis-ci.org/final-form/final-form-set-field-data)

[![codecov.io](https://codecov.io/gh/final-form/final-form-set-field-data/branch/master/graph/badge.svg)](https://codecov.io/gh/final-form/final-form-set-field-data)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Mutator for setting arbitrary metadata for fields in

[🏁 Final Form](https://github.com/final-form/final-form).

---

## Installation

```bash

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

```

or

```bash

yarn add final-form-set-field-data

```

## Usage

```js

import { createForm } from 'final-form'

import setFieldData from 'final-form-set-field-data'

// Create Form

const form = createForm({

  mutators: { setFieldData },

  onSubmit

})

form.mutators.setFieldData('firstName', { awesome: true })

form.registerField(

  'firstName',

  fieldState => {

    const { awesome } = fieldState.data // true

  },

  {

    // ...other subscription items

    data: true

  }

)

```

## Mutator

### `form.mutators.setFieldData(name: string, values: Object) => void`

Merges the values provided into the `data` value for the specified field