Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redux-form/redux-form

A Higher Order Component using react-redux to keep form state in a Redux store
https://github.com/redux-form/redux-form

form form-validation forms react redux redux-form validation

Last synced: 4 days ago
JSON representation

A Higher Order Component using react-redux to keep form state in a Redux store

Host: GitHub
URL: https://github.com/redux-form/redux-form
Owner: redux-form
License: mit
Created: 2015-07-31T16:07:03.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-06-13T12:17:05.000Z (5 months ago)
Last Synced: 2024-10-31T01:09:32.343Z (5 days ago)
Topics: form, form-validation, forms, react, redux, redux-form, validation
Language: JavaScript
Homepage: https://redux-form.com
Size: 9.56 MB
Stars: 12,573
Watchers: 172
Forks: 1,635
Open Issues: 495
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/security.md

Awesome Lists containing this project

awesome-react-components-all - redux-form - A Higher Order Component using react-redux to keep form state in a Redux store. (Uncategorized / Uncategorized)
awesome-react - redux-form - Redux form state management (Web and Native). ![](https://img.shields.io/github/stars/redux-form/redux-form.svg?style=social&label=Star) (UI Components / Form Components)
awesome-github-star - redux-form - redux to keep form state in a Redux store | redux-form | 12599 | (JavaScript)
awesome - redux-form - A Higher Order Component using react-redux to keep form state in a Redux store (JavaScript)
awesome-react-native - redux-form - Redux form state management (Web and Native). ![](https://img.shields.io/github/stars/redux-form/redux-form.svg?style=social&label=Star) (Components / Forms)

README

        [](https://redux-form.com/)

# redux-form

---

[](https://formnerd.co/redux-form-readme) **You build great forms, but do you know HOW users use your forms? [Find out with Form Nerd!](https://formnerd.co/redux-form-readme) Professional analytics from the creator of Redux Form.**

---

[![NPM Version](https://img.shields.io/npm/v/redux-form.svg?style=flat)](https://www.npmjs.com/package/redux-form)

[![NPM Downloads](https://img.shields.io/npm/dm/redux-form.svg?style=flat)](https://npmcharts.com/compare/redux-form?minimal=true)

[![Build Status](https://img.shields.io/travis/redux-form/redux-form/v6.svg?style=flat)](https://travis-ci.com/redux-form/redux-form)

[![codecov.io](https://codecov.io/gh/redux-form/redux-form/branch/master/graph/badge.svg)](https://codecov.io/gh/redux-form/redux-form)

[![Code Climate](https://codeclimate.com/github/redux-form/redux-form/badges/gpa.svg)](https://codeclimate.com/github/redux-form/redux-form)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Twitter URL](https://img.shields.io/twitter/url/https/github.com/redux-form/redux-form.svg?style=social)](https://twitter.com/intent/tweet?text=With%20@ReduxForm,%20I%20can%20keep%20all%20my%20form%20state%20in%20Redux!%20Thanks,%20@erikras!)

[![Patreon](https://img.shields.io/badge/patreon-support%20the%20author-blue.svg)](https://www.patreon.com/erikras)

[![Backers on Open Collective](https://opencollective.com/redux-form/backers/badge.svg)](#backers)

[![Sponsors on Open Collective](https://opencollective.com/redux-form/sponsors/badge.svg)](#sponsors)

`redux-form` works with [React Redux](https://github.com/reactjs/react-redux) to

enable an html form in [React](https://github.com/facebook/react) to use

[Redux](https://github.com/reactjs/redux) to store all of its state.

---

💰**Psst!! Do you know React and Redux? [Sign up with Triplebyte](https://triplebyte.com/a/V6j0KPS/rf) to get offers from top tech companies!** 💰

---

## ⚠️ ATTENTION ⚠️

If you're just getting started with your application and are looking for a form solution, the [general consensus of the community](https://twitter.com/acemarke/status/1124771065115185152) is that you should _not_ put your form state in Redux. The author of Redux Form took all of the lessons he learned about form use cases from maintaining Redux Form and built [🏁 React Final Form](https://github.com/final-form/react-final-form#-react-final-form), which he recommends you use if you are just starting your project. It's also pretty easy to migrate to from Redux Form, because the `` component APIs are so similar. [Here is a blog post](https://codeburst.io/final-form-the-road-to-the-checkered-flag-cd9b75c25fe) where he explains his reasoning, or [there are two talks](https://github.com/final-form/react-final-form#videos) if you prefer video. [Formik](https://jaredpalmer.com/formik/) is also a nice solution.

The only good reason, [in the author's view](https://twitter.com/erikras/status/1035082880341483520), to use Redux Form in your application is if you need _really_ tight coupling of your form data with Redux, specifically if you need to subscribe to it and modify it from parts of your application far from your form component, e.g. on another route. If you don't have that requirement, use [🏁 React Final Form](https://github.com/final-form/react-final-form#-react-final-form).

## Installation

`npm install --save redux-form`

## Documentation

- [Getting Started](https://redux-form.com/8.2.2/docs/GettingStarted.md/)

- [Examples](https://redux-form.com/8.2.2/examples/)

- [API](https://redux-form.com/8.2.2/docs/api/)

- [FAQ](https://redux-form.com/8.2.2/docs/faq/)

- [Release Notes](https://github.com/redux-form/redux-form/releases)

- [Older Documentation](https://redux-form.com/8.2.2/docs/DocumentationVersions.md/)

## 🏖 Code Sandboxes 🏖

You can play around with `redux-form` in these sandbox versions of the Examples.

- [Simple Form](https://codesandbox.io/s/mZRjw05yp)

- [Synchronous Validation](https://codesandbox.io/s/pQj03w7Y6)

- [Field-Level Validation](https://codesandbox.io/s/PNQYw1kVy)

- [Submit Validation](https://codesandbox.io/s/XoA5vXDgA)

- [Asynchronous Blur Validation](https://codesandbox.io/s/nKlYo387)

- [Initializing From State](https://codesandbox.io/s/MQnD536Km)

- [Field Arrays](https://codesandbox.io/s/Ww4QG1Wx)

- [Remote Submit](https://codesandbox.io/s/ElYvJR21K)

- [Normalizing](https://codesandbox.io/s/L8KWERjDw)

- [Immutable JS](https://codesandbox.io/s/ZVGJQBJMw)

- [Selecting Form Values](https://codesandbox.io/s/gJOBWZMRZ)

- [Wizard Form](https://codesandbox.io/s/0Qzz3843)

## Videos

| [![A Practical Guide to Redux Form – React Alicante 2017](docs/ReactAlicante2017.gif)](https://youtu.be/ey7H8h4ERHg) |

| :------------------------------------------------------------------------------------------------------------------: |

|                              **A Practical Guide to Redux Form – React Alicante 2017**                               |

| [![Abstracting Form State with Redux Form – JS Channel 2016](docs/JSChannel2016.gif)](https://youtu.be/eDTi7lYR1VU) |

| :-----------------------------------------------------------------------------------------------------------------: |

|                            **Abstracting Form State with Redux Form – JS Channel 2016**                             |

## Contributors

This project exists thanks to all the people who contribute.



## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/redux-form#backer)]



## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/redux-form#sponsor)]