Skip to content

Commit 35c462e

Browse files
committed
updated examples readme
1 parent 67b9926 commit 35c462e

File tree

7 files changed

+58
-11
lines changed

7 files changed

+58
-11
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Examples
2+
3+
Below are a list of examples that demonstrate the capabilities of `redux-form` for testing and
4+
learning purposes.
5+
6+
Each example is its own standalone web app with hot reloading. To run them locally, clone the
7+
`redux-form` repository, `cd` into an example folder, and run `npm install` and `npm start`. Then
8+
open [`localhost:3030`](http://localhost:3030) in your browser.
9+
10+
---
11+
12+
### [Simple Form](simple)
13+
14+
> The simplest form. Demonstrates how to attach standard inputs to Redux.
15+
16+
---
17+
18+
### [Synchronous Validation](syncValidation)
19+
20+
> How to add synchronous client-side validation to your form.
21+
22+
---
23+
24+
### [Submit Validation](submitValidation)
25+
26+
> How to return server-side validation errors back from your submit function.
27+
28+
---
29+
30+
### [Aynchronous Blur Validation](asyncValidation)
31+
32+
> How to run asynchronous server-side validation on your form when certain fields lose focus.
33+
34+
---
35+
36+
### [Initializing From State](initializeFromState)
37+
38+
> How to initialize your form data from any slice of the Redux state.
39+
40+
---
41+
42+
### [Immutable JS](immutable)
43+
44+
> How to use Immutable JS for `redux-form` state storage.
45+
46+
---
47+

asyncValidation/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Simple Form Example
1+
# Aynchronous Blur Validation Example
22

33
## To run locally
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

immutable/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Simple Form Example
1+
# Immutable JS Example
22

33
## To run locally
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

initializeFromState/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Simple Form Example
1+
# Initialize From State Example
22

33
## To run locally
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

simple/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

submitValidation/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Simple Form Example
1+
# Submit Validation Example
22

33
## To run locally
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

syncValidation/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Simple Form Example
1+
# Synchronous Validation Example
22

33
## To run locally
44

55
```
66
npm install
7-
npm run dev
7+
npm start
88
```
99

1010
Then open [`http://localhost:3030/`](http://localhost:3030/).

0 commit comments

Comments
 (0)