Skip to content

Commit c9e560f

Browse files
committed
Generated TOC
1 parent 436d089 commit c9e560f

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ yarn add react-final-form-arrays react-final-form final-form final-form-arrays
2525
🏁 React Final Form Arrays provides a way to render arrays in 🏁 React Final
2626
Form.
2727

28-
```js
28+
```jsx
2929
import { Form, Field } from 'react-final-form'
3030
import arrayMutators from 'final-form-arrays'
3131
import { FieldArray } from 'react-final-form-arrays'
@@ -81,6 +81,47 @@ const MyForm = () => (
8181

8282
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
8383

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

86127
## Examples

0 commit comments

Comments
 (0)