api documentation for redux-form (v6.6.3)

A higher order component decorator for forms using Redux and React

table of contents

  1. module redux-form
    1. function redux-form.Field (props, context)
    2. function redux-form.FieldArray (props, context)
    3. function redux-form.Fields (props, context)
    4. function redux-form.Form (props, context)
    5. function redux-form.FormSection (props, context)
    6. function redux-form.SubmissionError (errors)
    7. function redux-form.arrayInsert (form, field, index, value)
    8. function redux-form.arrayMove (form, field, from, to)
    9. function redux-form.arrayPop (form, field)
    10. function redux-form.arrayPush (form, field, value)
    11. function redux-form.arrayRemove (form, field, index)
    12. function redux-form.arrayRemoveAll (form, field)
    13. function redux-form.arrayShift (form, field)
    14. function redux-form.arraySplice (form, field, index, removeNum, value)
    15. function redux-form.arraySwap (form, field, indexA, indexB)
    16. function redux-form.arrayUnshift (form, field, value)
    17. function redux-form.autofill (form, field, value)
    18. function redux-form.blur (form, field, value, touch)
    19. function redux-form.change (form, field, value, touch, persistentSubmitErrors)
    20. function redux-form.clearSubmitErrors (form)
    21. function redux-form.destroy ()
    22. function redux-form.focus (form, field)
    23. function redux-form.formValueSelector (form)
    24. function redux-form.getFormAsyncErrors (form)
    25. function redux-form.getFormInitialValues (form)
    26. function redux-form.getFormNames ()
    27. function redux-form.getFormSubmitErrors (form)
    28. function redux-form.getFormSyncErrors (form)
    29. function redux-form.getFormSyncWarnings (form)
    30. function redux-form.getFormValues (form)
    31. function redux-form.hasSubmitFailed (form)
    32. function redux-form.hasSubmitSucceeded (form)
    33. function redux-form.initialize (form, values, keepDirty)
    34. function redux-form.isDirty (form, getFormState)
    35. function redux-form.isInvalid (form, getFormState)
    36. function redux-form.isPristine (form)
    37. function redux-form.isSubmitting (form)
    38. function redux-form.isValid (form)
    39. function redux-form.propTypes.array ()
    40. function redux-form.propTypes.error ()
    41. function redux-form.propTypes.initialValues ()
    42. function redux-form.propTypes.triggerSubmit ()
    43. function redux-form.reducer ()
    44. function redux-form.reduxForm (initialConfig)
    45. function redux-form.registerField (form, name, type)
    46. function redux-form.reset (form)
    47. function redux-form.setSubmitFailed (form)
    48. function redux-form.setSubmitSucceeded (form)
    49. function redux-form.startAsyncValidation (form, field)
    50. function redux-form.startSubmit (form)
    51. function redux-form.stopAsyncValidation (form, errors)
    52. function redux-form.stopSubmit (form, errors)
    53. function redux-form.submit (form)
    54. function redux-form.touch (form)
    55. function redux-form.unregisterField (form, name)
    56. function redux-form.untouch (form)
    57. function redux-form.values (config)
    58. object redux-form.ConnectedField
    59. object redux-form.ConnectedFieldArray
    60. object redux-form.ConnectedFields
    61. object redux-form.actionTypes
    62. object redux-form.actions
    63. object redux-form.asyncValidation
    64. object redux-form.createAll
    65. object redux-form.createFieldArrayProps
    66. object redux-form.createFieldProps
    67. object redux-form.deepEqual
    68. object redux-form.defaultShouldAsyncValidate
    69. object redux-form.defaultShouldValidate
    70. object redux-form.deleteIn
    71. object redux-form.deleteInWithCleanUp
    72. object redux-form.eventMocks
    73. object redux-form.generateValidator
    74. object redux-form.getDisplayName
    75. object redux-form.getIn
    76. object redux-form.getValue
    77. object redux-form.handleSubmit
    78. object redux-form.hasError
    79. object redux-form.isChecked
    80. object redux-form.isEvent
    81. object redux-form.keys
    82. object redux-form.onChangeValue
    83. object redux-form.prefixName
    84. object redux-form.propTypes
    85. object redux-form.setIn
    86. object redux-form.shallowCompare
    87. object redux-form.silenceEvent
    88. object redux-form.silenceEvents
    89. object redux-form.splice
  2. module redux-form.ConnectedField
    1. function redux-form.ConnectedField.default (_ref)
  3. module redux-form.ConnectedFieldArray
    1. function redux-form.ConnectedFieldArray.default (_ref)
  4. module redux-form.ConnectedFields
    1. function redux-form.ConnectedFields.default (_ref)
  5. module redux-form.Field
    1. function redux-form.Field.default (_ref)
  6. module redux-form.FieldArray
    1. function redux-form.FieldArray.default (_ref2)
  7. module redux-form.Fields
    1. function redux-form.Fields.default (_ref)
  8. module redux-form.Form
    1. function redux-form.Form.default (props, context)
  9. module redux-form.FormSection
    1. function redux-form.FormSection.default (props, context)
  10. module redux-form.SubmissionError
    1. function redux-form.SubmissionError.default (errors)
  11. module redux-form.actions
    1. function redux-form.actions.arrayInsert (form, field, index, value)
    2. function redux-form.actions.arrayMove (form, field, from, to)
    3. function redux-form.actions.arrayPop (form, field)
    4. function redux-form.actions.arrayPush (form, field, value)
    5. function redux-form.actions.arrayRemove (form, field, index)
    6. function redux-form.actions.arrayRemoveAll (form, field)
    7. function redux-form.actions.arrayShift (form, field)
    8. function redux-form.actions.arraySplice (form, field, index, removeNum, value)
    9. function redux-form.actions.arraySwap (form, field, indexA, indexB)
    10. function redux-form.actions.arrayUnshift (form, field, value)
    11. function redux-form.actions.autofill (form, field, value)
    12. function redux-form.actions.blur (form, field, value, touch)
    13. function redux-form.actions.change (form, field, value, touch, persistentSubmitErrors)
    14. function redux-form.actions.clearAsyncError (form, field)
    15. function redux-form.actions.clearSubmit (form)
    16. function redux-form.actions.clearSubmitErrors (form)
    17. function redux-form.actions.destroy ()
    18. function redux-form.actions.focus (form, field)
    19. function redux-form.actions.initialize (form, values, keepDirty)
    20. function redux-form.actions.registerField (form, name, type)
    21. function redux-form.actions.reset (form)
    22. function redux-form.actions.setSubmitFailed (form)
    23. function redux-form.actions.setSubmitSucceeded (form)
    24. function redux-form.actions.startAsyncValidation (form, field)
    25. function redux-form.actions.startSubmit (form)
    26. function redux-form.actions.stopAsyncValidation (form, errors)
    27. function redux-form.actions.stopSubmit (form, errors)
    28. function redux-form.actions.submit (form)
    29. function redux-form.actions.touch (form)
    30. function redux-form.actions.unregisterField (form, name)
    31. function redux-form.actions.untouch (form)
    32. function redux-form.actions.updateSyncErrors (form)
    33. function redux-form.actions.updateSyncWarnings (form)
  12. module redux-form.asyncValidation
    1. function redux-form.asyncValidation.default (fn, start, stop, field)
  13. module redux-form.createAll
    1. function redux-form.createAll.default (structure)
  14. module redux-form.createFieldArrayProps
    1. function redux-form.createFieldArrayProps.default (getIn, name, form, sectionPrefix, getValue, _ref)
  15. module redux-form.createFieldProps
    1. function redux-form.createFieldProps.default (_ref2, name, _ref)
  16. module redux-form.deepEqual
    1. function redux-form.deepEqual.default (a, b)
  17. module redux-form.defaultShouldAsyncValidate
    1. function redux-form.defaultShouldAsyncValidate.default (_ref)
  18. module redux-form.defaultShouldValidate
    1. function redux-form.defaultShouldValidate.default (_ref)
  19. module redux-form.deleteIn
    1. function redux-form.deleteIn.default (state, field)
  20. module redux-form.deleteInWithCleanUp
    1. function redux-form.deleteInWithCleanUp.default (_ref)
  21. module redux-form.eventMocks
    1. function redux-form.eventMocks.dragStartMock (setData)
    2. function redux-form.eventMocks.dropMock (getData)
    3. function redux-form.eventMocks.valueMock (value)
  22. module redux-form.formValueSelector
    1. function redux-form.formValueSelector.default (_ref)
  23. module redux-form.generateValidator
    1. function redux-form.generateValidator.default (validators, _ref)
  24. module redux-form.getDisplayName
    1. function redux-form.getDisplayName.default (Comp)
  25. module redux-form.getFormAsyncErrors
    1. function redux-form.getFormAsyncErrors.default (_ref)
  26. module redux-form.getFormInitialValues
    1. function redux-form.getFormInitialValues.default (_ref)
  27. module redux-form.getFormNames
    1. function redux-form.getFormNames.default (_ref)
  28. module redux-form.getFormSubmitErrors
    1. function redux-form.getFormSubmitErrors.default (_ref)
  29. module redux-form.getFormSyncErrors
    1. function redux-form.getFormSyncErrors.default (_ref)
  30. module redux-form.getFormSyncWarnings
    1. function redux-form.getFormSyncWarnings.default (_ref)
  31. module redux-form.getFormValues
    1. function redux-form.getFormValues.default (_ref)
  32. module redux-form.getIn
    1. function redux-form.getIn.default (state, field)
  33. module redux-form.getValue
    1. function redux-form.getValue.default (event, isReactNative)
  34. module redux-form.handleSubmit
    1. function redux-form.handleSubmit.default (submit, props, valid, asyncValidate, fields)
  35. module redux-form.hasError
    1. function redux-form.hasError.default (_ref)
  36. module redux-form.hasSubmitFailed
    1. function redux-form.hasSubmitFailed.default (_ref)
  37. module redux-form.hasSubmitSucceeded
    1. function redux-form.hasSubmitSucceeded.default (_ref)
  38. module redux-form.isChecked
    1. function redux-form.isChecked.default (value)
  39. module redux-form.isDirty
    1. function redux-form.isDirty.default (structure)
  40. module redux-form.isEvent
    1. function redux-form.isEvent.default (candidate)
  41. module redux-form.isInvalid
    1. function redux-form.isInvalid.default (structure)
  42. module redux-form.isPristine
    1. function redux-form.isPristine.default (_ref)
  43. module redux-form.isSubmitting
    1. function redux-form.isSubmitting.default (_ref)
  44. module redux-form.isValid
    1. function redux-form.isValid.default (structure)
  45. module redux-form.keys
    1. function redux-form.keys.default (value)
  46. module redux-form.onChangeValue
    1. function redux-form.onChangeValue.default (event, _ref)
  47. module redux-form.prefixName
    1. function redux-form.prefixName.default (context, name)
  48. module redux-form.propTypes
    1. function redux-form.propTypes.anyTouched ()
    2. function redux-form.propTypes.array ()
    3. function redux-form.propTypes.asyncValidate ()
    4. function redux-form.propTypes.asyncValidating ()
    5. function redux-form.propTypes.autofill ()
    6. function redux-form.propTypes.blur ()
    7. function redux-form.propTypes.change ()
    8. function redux-form.propTypes.clearAsyncError ()
    9. function redux-form.propTypes.clearSubmit ()
    10. function redux-form.propTypes.destroy ()
    11. function redux-form.propTypes.dirty ()
    12. function redux-form.propTypes.dispatch ()
    13. function redux-form.propTypes.error ()
    14. function redux-form.propTypes.form ()
    15. function redux-form.propTypes.handleSubmit ()
    16. function redux-form.propTypes.initialValues ()
    17. function redux-form.propTypes.initialize ()
    18. function redux-form.propTypes.initialized ()
    19. function redux-form.propTypes.invalid ()
    20. function redux-form.propTypes.pristine ()
    21. function redux-form.propTypes.pure ()
    22. function redux-form.propTypes.reset ()
    23. function redux-form.propTypes.submit ()
    24. function redux-form.propTypes.submitFailed ()
    25. function redux-form.propTypes.submitSucceeded ()
    26. function redux-form.propTypes.submitting ()
    27. function redux-form.propTypes.touch ()
    28. function redux-form.propTypes.triggerSubmit ()
    29. function redux-form.propTypes.untouch ()
    30. function redux-form.propTypes.valid ()
    31. function redux-form.propTypes.warning ()
  49. module redux-form.propTypes.array
    1. function redux-form.propTypes.array ()
    2. function redux-form.propTypes.array.isRequired ()
  50. module redux-form.propTypes.error
    1. function redux-form.propTypes.error ()
    2. function redux-form.propTypes.error.isRequired ()
  51. module redux-form.propTypes.initialValues
    1. function redux-form.propTypes.initialValues ()
    2. function redux-form.propTypes.initialValues.isRequired ()
  52. module redux-form.propTypes.triggerSubmit
    1. function redux-form.propTypes.triggerSubmit ()
    2. function redux-form.propTypes.triggerSubmit.isRequired ()
  53. module redux-form.reducer
    1. function redux-form.reducer ()
    2. function redux-form.reducer.plugin (reducers)
  54. module redux-form.reduxForm
    1. function redux-form.reduxForm.default (structure)
  55. module redux-form.setIn
    1. function redux-form.setIn.default (state, field, value)
  56. module redux-form.shallowCompare
    1. function redux-form.shallowCompare.default (instance, nextProps, nextState)
  57. module redux-form.silenceEvent
    1. function redux-form.silenceEvent.default (event)
  58. module redux-form.silenceEvents
    1. function redux-form.silenceEvents.default (fn)
  59. module redux-form.splice
    1. function redux-form.splice.default (array, index, removeNum, value)
  60. module redux-form.values
    1. function redux-form.values.default (_ref)

module redux-form

function redux-form.Field (props, context)

function redux-form.FieldArray (props, context)

function redux-form.Fields (props, context)

function redux-form.Form (props, context)

function redux-form.FormSection (props, context)

function redux-form.SubmissionError (errors)

function redux-form.arrayInsert (form, field, index, value)

function redux-form.arrayMove (form, field, from, to)

function redux-form.arrayPop (form, field)

function redux-form.arrayPush (form, field, value)

function redux-form.arrayRemove (form, field, index)

function redux-form.arrayRemoveAll (form, field)

function redux-form.arrayShift (form, field)

function redux-form.arraySplice (form, field, index, removeNum, value)

function redux-form.arraySwap (form, field, indexA, indexB)

function redux-form.arrayUnshift (form, field, value)

function redux-form.autofill (form, field, value)

function redux-form.blur (form, field, value, touch)

function redux-form.change (form, field, value, touch, persistentSubmitErrors)

function redux-form.clearSubmitErrors (form)

function redux-form.destroy ()

function redux-form.focus (form, field)

function redux-form.formValueSelector (form)

function redux-form.getFormAsyncErrors (form)

function redux-form.getFormInitialValues (form)

function redux-form.getFormNames ()

function redux-form.getFormSubmitErrors (form)

function redux-form.getFormSyncErrors (form)

function redux-form.getFormSyncWarnings (form)

function redux-form.getFormValues (form)

function redux-form.hasSubmitFailed (form)

function redux-form.hasSubmitSucceeded (form)

function redux-form.initialize (form, values, keepDirty)

function redux-form.isDirty (form, getFormState)

function redux-form.isInvalid (form, getFormState)

function redux-form.isPristine (form)

function redux-form.isSubmitting (form)

function redux-form.isValid (form)

function redux-form.propTypes.array ()

function redux-form.propTypes.error ()

function redux-form.propTypes.initialValues ()

function redux-form.propTypes.triggerSubmit ()

function redux-form.reducer ()

function redux-form.reduxForm (initialConfig)

function redux-form.registerField (form, name, type)

function redux-form.reset (form)

function redux-form.setSubmitFailed (form)

function redux-form.setSubmitSucceeded (form)

function redux-form.startAsyncValidation (form, field)

function redux-form.startSubmit (form)

function redux-form.stopAsyncValidation (form, errors)

function redux-form.stopSubmit (form, errors)

function redux-form.submit (form)

function redux-form.touch (form)

function redux-form.unregisterField (form, name)

function redux-form.untouch (form)

function redux-form.values (config)

module redux-form.ConnectedField

function redux-form.ConnectedField.default (_ref)

module redux-form.ConnectedFieldArray

function redux-form.ConnectedFieldArray.default (_ref)

module redux-form.ConnectedFields

function redux-form.ConnectedFields.default (_ref)

module redux-form.Field

function redux-form.Field.default (_ref)

module redux-form.FieldArray

function redux-form.FieldArray.default (_ref2)

module redux-form.Fields

function redux-form.Fields.default (_ref)

module redux-form.Form

function redux-form.Form.default (props, context)

module redux-form.FormSection

function redux-form.FormSection.default (props, context)

module redux-form.SubmissionError

function redux-form.SubmissionError.default (errors)

module redux-form.actions

function redux-form.actions.arrayInsert (form, field, index, value)

function redux-form.actions.arrayMove (form, field, from, to)

function redux-form.actions.arrayPop (form, field)

function redux-form.actions.arrayPush (form, field, value)

function redux-form.actions.arrayRemove (form, field, index)

function redux-form.actions.arrayRemoveAll (form, field)

function redux-form.actions.arrayShift (form, field)

function redux-form.actions.arraySplice (form, field, index, removeNum, value)

function redux-form.actions.arraySwap (form, field, indexA, indexB)

function redux-form.actions.arrayUnshift (form, field, value)

function redux-form.actions.autofill (form, field, value)

function redux-form.actions.blur (form, field, value, touch)

function redux-form.actions.change (form, field, value, touch, persistentSubmitErrors)

function redux-form.actions.clearAsyncError (form, field)

function redux-form.actions.clearSubmit (form)

function redux-form.actions.clearSubmitErrors (form)

function redux-form.actions.destroy ()

function redux-form.actions.focus (form, field)

function redux-form.actions.initialize (form, values, keepDirty)

function redux-form.actions.registerField (form, name, type)

function redux-form.actions.reset (form)

function redux-form.actions.setSubmitFailed (form)

function redux-form.actions.setSubmitSucceeded (form)

function redux-form.actions.startAsyncValidation (form, field)

function redux-form.actions.startSubmit (form)

function redux-form.actions.stopAsyncValidation (form, errors)

function redux-form.actions.stopSubmit (form, errors)

function redux-form.actions.submit (form)

function redux-form.actions.touch (form)

function redux-form.actions.unregisterField (form, name)

function redux-form.actions.untouch (form)

function redux-form.actions.updateSyncErrors (form)

function redux-form.actions.updateSyncWarnings (form)

module redux-form.asyncValidation

function redux-form.asyncValidation.default (fn, start, stop, field)

module redux-form.createAll

function redux-form.createAll.default (structure)

module redux-form.createFieldArrayProps

function redux-form.createFieldArrayProps.default (getIn, name, form, sectionPrefix, getValue, _ref)

module redux-form.createFieldProps

function redux-form.createFieldProps.default (_ref2, name, _ref)

module redux-form.deepEqual

function redux-form.deepEqual.default (a, b)

module redux-form.defaultShouldAsyncValidate

function redux-form.defaultShouldAsyncValidate.default (_ref)

module redux-form.defaultShouldValidate

function redux-form.defaultShouldValidate.default (_ref)

module redux-form.deleteIn

function redux-form.deleteIn.default (state, field)

module redux-form.deleteInWithCleanUp

function redux-form.deleteInWithCleanUp.default (_ref)

module redux-form.eventMocks

function redux-form.eventMocks.dragStartMock (setData)

function redux-form.eventMocks.dropMock (getData)

function redux-form.eventMocks.valueMock (value)

module redux-form.formValueSelector

function redux-form.formValueSelector.default (_ref)

module redux-form.generateValidator

function redux-form.generateValidator.default (validators, _ref)

module redux-form.getDisplayName

function redux-form.getDisplayName.default (Comp)

module redux-form.getFormAsyncErrors

function redux-form.getFormAsyncErrors.default (_ref)

module redux-form.getFormInitialValues

function redux-form.getFormInitialValues.default (_ref)

module redux-form.getFormNames

function redux-form.getFormNames.default (_ref)

module redux-form.getFormSubmitErrors

function redux-form.getFormSubmitErrors.default (_ref)

module redux-form.getFormSyncErrors

function redux-form.getFormSyncErrors.default (_ref)

module redux-form.getFormSyncWarnings

function redux-form.getFormSyncWarnings.default (_ref)

module redux-form.getFormValues

function redux-form.getFormValues.default (_ref)

module redux-form.getIn

function redux-form.getIn.default (state, field)

module redux-form.getValue

function redux-form.getValue.default (event, isReactNative)

module redux-form.handleSubmit

function redux-form.handleSubmit.default (submit, props, valid, asyncValidate, fields)

module redux-form.hasError

function redux-form.hasError.default (_ref)

module redux-form.hasSubmitFailed

function redux-form.hasSubmitFailed.default (_ref)

module redux-form.hasSubmitSucceeded

function redux-form.hasSubmitSucceeded.default (_ref)

module redux-form.isChecked

function redux-form.isChecked.default (value)

module redux-form.isDirty

function redux-form.isDirty.default (structure)

module redux-form.isEvent

function redux-form.isEvent.default (candidate)

module redux-form.isInvalid

function redux-form.isInvalid.default (structure)

module redux-form.isPristine

function redux-form.isPristine.default (_ref)

module redux-form.isSubmitting

function redux-form.isSubmitting.default (_ref)

module redux-form.isValid

function redux-form.isValid.default (structure)

module redux-form.keys

function redux-form.keys.default (value)

module redux-form.onChangeValue

function redux-form.onChangeValue.default (event, _ref)

module redux-form.prefixName

function redux-form.prefixName.default (context, name)

module redux-form.propTypes

function redux-form.propTypes.anyTouched ()

function redux-form.propTypes.array ()

function redux-form.propTypes.asyncValidate ()

function redux-form.propTypes.asyncValidating ()

function redux-form.propTypes.autofill ()

function redux-form.propTypes.blur ()

function redux-form.propTypes.change ()

function redux-form.propTypes.clearAsyncError ()

function redux-form.propTypes.clearSubmit ()

function redux-form.propTypes.destroy ()

function redux-form.propTypes.dirty ()

function redux-form.propTypes.dispatch ()

function redux-form.propTypes.error ()

function redux-form.propTypes.form ()

function redux-form.propTypes.handleSubmit ()

function redux-form.propTypes.initialValues ()

function redux-form.propTypes.initialize ()

function redux-form.propTypes.initialized ()

function redux-form.propTypes.invalid ()

function redux-form.propTypes.pristine ()

function redux-form.propTypes.pure ()

function redux-form.propTypes.reset ()

function redux-form.propTypes.submit ()

function redux-form.propTypes.submitFailed ()

function redux-form.propTypes.submitSucceeded ()

function redux-form.propTypes.submitting ()

function redux-form.propTypes.touch ()

function redux-form.propTypes.triggerSubmit ()

function redux-form.propTypes.untouch ()

function redux-form.propTypes.valid ()

function redux-form.propTypes.warning ()

module redux-form.propTypes.array

function redux-form.propTypes.array ()

function redux-form.propTypes.array.isRequired ()

module redux-form.propTypes.error

function redux-form.propTypes.error ()

function redux-form.propTypes.error.isRequired ()

module redux-form.propTypes.initialValues

function redux-form.propTypes.initialValues ()

function redux-form.propTypes.initialValues.isRequired ()

module redux-form.propTypes.triggerSubmit

function redux-form.propTypes.triggerSubmit ()

function redux-form.propTypes.triggerSubmit.isRequired ()

module redux-form.reducer

function redux-form.reducer ()

function redux-form.reducer.plugin (reducers)

module redux-form.reduxForm

function redux-form.reduxForm.default (structure)

module redux-form.setIn

function redux-form.setIn.default (state, field, value)

module redux-form.shallowCompare

function redux-form.shallowCompare.default (instance, nextProps, nextState)

module redux-form.silenceEvent

function redux-form.silenceEvent.default (event)

module redux-form.silenceEvents

function redux-form.silenceEvents.default (fn)

module redux-form.splice

function redux-form.splice.default (array, index, removeNum, value)

module redux-form.values

function redux-form.values.default (_ref)

[ this document was created with utility2 ]