Skip to content

Commit 54e369b

Browse files
shirbr510erikras
authored andcommitted
add React Beautiful DnD Example to README.md (#62)
1 parent 9ff91ac commit 54e369b

File tree

1 file changed

+5
-41
lines changed

1 file changed

+5
-41
lines changed

README.md

+5-41
Original file line numberDiff line numberDiff line change
@@ -79,47 +79,7 @@ const MyForm = () => (
7979
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
8080
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
8181

82-
- [Examples](#examples)
83-
- [Simple Example](#simple-example)
84-
- [Rendering](#rendering)
85-
- [API](#api)
86-
- [`FieldArray : React.ComponentType<FieldArrayProps>`](#fieldarray--reactcomponenttypefieldarrayprops)
87-
- [`version: string`](#version-string)
88-
- [Types](#types)
89-
- [`FieldArrayProps`](#fieldarrayprops)
90-
- [`children?: ((props: FieldArrayRenderProps) => React.Node) | React.Node`](#children-props-fieldarrayrenderprops--reactnode--reactnode)
91-
- [`component?: React.ComponentType<FieldArrayRenderProps>`](#component-reactcomponenttypefieldarrayrenderprops)
92-
- [`name: string`](#name-string)
93-
- [`render?: (props: FieldArrayRenderProps) => React.Node`](#render-props-fieldarrayrenderprops--reactnode)
94-
- [`isEqual?: (allPreviousValues: Array<any>, allNewValues: Array<any>) => boolean`](#isequal-allpreviousvalues-arrayany-allnewvalues-arrayany--boolean)
95-
- [`subscription?: FieldSubscription`](#subscription-fieldsubscription)
96-
- [`validate?: (value: ?any[], allValues: Object) => ?any`](#validate-value-any-allvalues-object--any)
97-
- [`FieldArrayRenderProps`](#fieldarrayrenderprops)
98-
- [`fields.forEach: (iterator: (name: string, index: number) => void) => void`](#fieldsforeach-iterator-name-string-index-number--void--void)
99-
- [`fields.insert: (index: number, value: any) => void`](#fieldsinsert-index-number-value-any--void)
100-
- [`fields.map: (iterator: (name: string, index: number) => any) => any[]`](#fieldsmap-iterator-name-string-index-number--any--any)
101-
- [`fields.move: (from: number, to: number) => void`](#fieldsmove-from-number-to-number--void)
102-
- [`fields.name: string`](#fieldsname-string)
103-
- [`fields.pop: () => any`](#fieldspop---any)
104-
- [`fields.push: (value: any) => void`](#fieldspush-value-any--void)
105-
- [`fields.remove: (index: number) => any`](#fieldsremove-index-number--any)
106-
- [`fields.shift: () => any`](#fieldsshift---any)
107-
- [`fields.swap: (indexA: number, indexB: number) => void`](#fieldsswap-indexa-number-indexb-number--void)
108-
- [`fields.update: (index: number, value: any) => void`](#fieldsupdate-index-number-value-any--void)
109-
- [`fields.unshift: (value: any) => void`](#fieldsunshift-value-any--void)
110-
- [`meta.active?: boolean`](#metaactive-boolean)
111-
- [`meta.data: Object`](#metadata-object)
112-
- [`meta.dirty?: boolean`](#metadirty-boolean)
113-
- [`meta.error?: any`](#metaerror-any)
114-
- [`meta.initial?: any`](#metainitial-any)
115-
- [`meta.invalid?: boolean`](#metainvalid-boolean)
116-
- [`meta.pristine?: boolean`](#metapristine-boolean)
117-
- [`meta.submitError?: any`](#metasubmiterror-any)
118-
- [`meta.submitFailed?: boolean`](#metasubmitfailed-boolean)
119-
- [`meta.submitSucceeded?: boolean`](#metasubmitsucceeded-boolean)
120-
- [`meta.touched?: boolean`](#metatouched-boolean)
121-
- [`meta.valid?: boolean`](#metavalid-boolean)
122-
- [`meta.visited?: boolean`](#metavisited-boolean)
82+
12383

12484
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
12585

@@ -130,6 +90,10 @@ const MyForm = () => (
13090
Demostrates how to use `<FieldArray/>` to render an array of inputs, as well as
13191
use `push`, `pop`, and `remove` mutations.
13292

93+
### [React Beautiful DnD Example](https://codesandbox.io/s/8k0ykyr7z9)
94+
95+
Demostrates how to integrate the simple example with [react-beautiful-dnd](https://github.com/atlassian/react-beautiful-dnd)
96+
13397
## Rendering
13498

13599
There are three ways to tell `<FieldArray/>` what to render:

0 commit comments

Comments
 (0)