Documentation

Modules: enhanced-redux-form/actions/compositeInputActions

All functions in this module are action creators and the return value should be passed to the redux store dispatch() function

Source:

Members

<static, constant> composeCompositeInputs

Uses the formatter passed to CompositeInput components to format the inner values of a CompositeInput to a composed value.

Source:

<static, constant> decomposeCompositeInput

Uses the decompose function in the compositeInputFormatter configuration to decompose a single composite value back to values of the inputs and update them accordingly. If no decompose function is configured, will ignore this call.

Source:

Methods

registerCompositeInput(form, field, formatter, composeOn)

Register a composite input mount

Parameters:
Name Type Description
form string

The id of the redux-form that the input is rendered in
field string

The name to register the composite input under
formatter Object

One of the formatters to use as defined in compositeInputFormatters.js
composeOn string

A string indicating on which event the composite input should run its formatter, besides running before each validation round
Source:
Returns:

The action

Type
object

unregisterCompositeInput(form, field)

Register a composite input unmount

Parameters:
Name Type Description
form string

The id of the redux-form that the input was rendered in
field string

The name of the composite input
Source:
Returns:

The action

Type
object