Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 9ff91ac

Browse files
maciejmyslinskierikras
authored andcommitted
63 update documentation (#64)
* provide custom isEqual function * Add isEqual prop to FieldArray component * add update method to the documentation
1 parent 9dd370c commit 9ff91ac

File tree

1 file changed

+45
-46
lines changed

1 file changed

+45
-46
lines changed

‎README.md

Lines changed: 45 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -76,55 +76,50 @@ const MyForm = () => (
7676
## Table of Contents
7777

7878
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
79-
8079
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
81-
8280
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
8381

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

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

@@ -264,6 +259,10 @@ returned.
264259

265260
A function to swap two values in the array.
266261

262+
#### `fields.update: (index: number, value: any) => void`
263+
264+
Updates a value of the specified index of the array field.
265+
267266
#### `fields.unshift: (value: any) => void`
268267

269268
A function to add a value to the beginning of the array.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /