- Redux Form
- API
- Action Creators
Action Creators
redux-form
exports all of its internal action creators, allowing you complete control to
dispatch any action you wish. However, it is recommended that you use the actions passed as
props to your component for most of your needs, as they are already bound to dispatch
, your
form, and, in the case of field-specific actions such as CHANGE
or BLUR
, the specific field.
blur(form:String, field:String, value:String)
Saves the value to the field.
change(form:String, field:String, value:String)
Saves the value to the field.
destroy(form:String)
Destroys the form, removing all its state.
focus(form:String, field:String)
Marks the given field as
active
andvisited
.
initialize(form:String, data:Object, fields:Array<String>)
Sets the initial values in the form with which future data values will be compared to calculate
dirty
andpristine
. Thedata
parameter may contain deep nested array and object values that match the shape of your form fields. IMPORTANT: The fields array passed must be the same as the one given as a config parameter toreduxForm()
.
reset(form:String)
Resets the values in the form back to the values past in with the most recent
initialize
action.
startAsyncValidation(form:String)
Flips the
asyncValidating
flagtrue
.
startSubmit(form:String)
Flips the
submitting
flagtrue
.
stopSubmit(form:String, errors:Object)
Flips the
submitting
flagfalse
and populatessubmitError
for each field.
stopAsyncValidation(form:String, errors:Object)
Flips the
asyncValidating
flagfalse
and populatesasyncError
for each field.
touch(form:String, ...fields:String)
Marks all the fields passed in as
touched
.
untouch(form:String, ...fields:String)
Resets the 'touched' flag for all the fields passed in.