formValues(options:Object<String, String> | valuesMapper:Function | name1:String, name2:String, ...)

View source on GitHub

A decorator to read a selection of the current form values. This is useful for subforms that change depending on the current values in the form.

Importing

var formValues = require('redux-form').formValues // ES5

import { formValues } from 'redux-form' // ES6

Parameters

name

The path to the field, exactly like the name parameter of <Field/>.

options: {prop: name, ...}

If you use the first form with the options object, the keys of the object will be the names of the props passed.

valuesMapper: (props) => name:String | (props) => options:Object<String, String>

A function to map values. Like this you can create the path to the field(s) dynamically. Return a name or an options object.

Usage

const ItemList = formValues('withVat')(MyItemizedList)

const ItemList = formValues({ showVat: 'withVat' })(MyItemizedList)

const ItemList = formValues(props => props.formValueName)(MyItemizedList)

const ItemList = formValues(props => ({ showVat: props.formValueName }))(
  MyItemizedList
)

These decorated components will now get the props withVat and showVat, respectively.

A note on performance

This decorator causes the component to render() every time one of the selected values changes. If you have a large form, this can cause some UI lag. (This is the reason that <Field/> components are attached to single form values)

Therefore, use this sparingly; perhaps you can solve your problem with a more specialized input component.