Skip to content
This repository has been archived by the owner on Sep 19, 2021. It is now read-only.

Latest commit

 

History

History
52 lines (36 loc) · 3.46 KB

README.md

File metadata and controls

52 lines (36 loc) · 3.46 KB
Raw

EOL

This package is currently unmaintained, and was only meant to be used on a temporary basis in the first place. I am no longer using or maintaining this package, and I hope that you are no longer using it either.

If you are still using this, I recommend upgrading your code to use the newer Redux APIs directly. See the Further migration steps section below for more detail.

If for whatever reason you think this package is still useful and worth your time to maintain, please reach out to me.

Purpose

Redux Form v6 was a major departure from previous versions. A direct upgrade from v5 to v6 would require practically rewriting every form in your application all at once, as no incremental upgrade path was provided. For any reasonbly large project, that is untennable.

This compatibility module (redux-form-compat) provides a (rough) incremental upgrade path.

The inversion of control can now be deferred on a form-by-form basis, relieving the major upgrade burden. The other migration steps must still be followed though as it is not our goal to provide full backwards compatibility.

Features

  • Supports fields argument to @reduxForm.
  • Supports mapStateToProps and mapDispatchToProps.
  • Supports deep fields.
  • Does not support legacy field arrays. They will need to be converted to use FieldArray, though other fields within the same form can continue to use fields instead of Field.
  • Supports choice of v5-style field props, v6-style, or a combination thereof.

Usage

  1. Upgrade redux-form to the latest version (7.1.2 was tested).
  2. Replace import { reduxForm } from 'redux-form' with import { reduxForm } from 'redux-form-compat'.
  3. Follow the other steps in the migration guide.
    1. handleSubmit/onSubmit should throw SubmissionError.
    2. Convert field arrays to use FieldArray.
    3. If normalization is used, those fields will need to be converted to either avoid normalization or use the new normalization.

Undocumented differences found when upgrading from redux-form 5.3.6 to 7.1.2:

  • The synchronous validate function will no loger receive empty objects when none of the nested fields have values.
  • The checked prop is no longer passed for boolean values, despite documentation to the contrary. In v5, the checked prop was always passed, with a value of true, false, or undefined.
  • onChange no longer magically unwraps objects that have a .value field.

Further migration steps:

These can be done at your leisure and don't need to be applied to the whole project at once.

  1. Pass fieldPropStyle: 'v5v6' when your code is ready to start receiving the input and meta. Change to 'v6' when the old-style props are no longer needed.
  2. Convert fields to use Field. (This can be done on an individual field basis.)
  3. If you pass more than one argument to reduxForm, switch the additional arguments to use @connect.
  4. Change imports back to import { reduxForm } from 'redux-form'.
  5. Remove any fieldPropStyle options you may have added. (They are unneeded after the form stops using redux-form-compat.)