Commit b826e98

authored

Documented and Typed fields.value (#96)

1 parent 71e8da3 commit b826e98Copy full SHA for b826e98

File tree

+29

-1

lines changed

+29

-1

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -279,6 +279,10 @@ Updates a value of the specified index of the array field.`
`279`	`279`
`280`	`280`	`A function to add a value to the beginning of the array.`
`281`	`281`
	`282`	+#### `fields.value: any[]`
	`283`	`+`
	`284`	`+The value of the array. Should be treated as readonly.`
	`285`	`+`
`282`	`286`	#### `meta.active?: boolean`
`283`	`287`
`284`	`288`	[See the 🏁 Final Form docs on `active`](https://github.com/final-form/final-form#active-boolean).

Lines changed: 22 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -682,6 +682,28 @@ describe('FieldArray', () => {`
`682`	`682`	`expect(getByTestId('values')).toHaveTextContent('')`
`683`	`683`	`})`
`684`	`684`
	`685`	`+ it('should provide value', () => {`
	`686`	`+ const renderArray = jest.fn(() => <div />)`
	`687`	`+ render(`
	`688`	`+ <Form`
	`689`	`+ onSubmit={onSubmitMock}`
	`690`	`+ mutators={arrayMutators}`
	`691`	`+ subscription={{}}`
	`692`	`+ initialValues={{ foo: ['a', 'b', 'c'] }}`
	`693`	`+ >`
	`694`	`+ {() => (`
	`695`	`+ <form>`
	`696`	`+ <FieldArray name="foo">{renderArray}</FieldArray>`
	`697`	`+ </form>`
	`698`	`+ )}`
	`699`	`+ </Form>`
	`700`	`+ )`
	`701`	`+ expect(renderArray).toHaveBeenCalled()`
	`702`	`+ expect(renderArray).toHaveBeenCalledTimes(1)`
	`703`	`+`
	`704`	`+ expect(renderArray.mock.calls[0][0].fields.value).toEqual(['a', 'b', 'c'])`
	`705`	`+ })`
	`706`	`+`
`685`	`707`	`// it('should respect record-level validation', () => {`
`686`	`708`	`// // https://github.com/final-form/react-final-form-arrays/pull/84`
`687`	`709`	`// const { getByTestId, getByText } = render(`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ export interface FieldArrayRenderProps<FieldValue, T extends HTMLElement> {`
`17`	`17`	`shift: () => FieldValue`
`18`	`18`	`swap: (indexA: number, indexB: number) => void`
`19`	`19`	`unshift: (value: FieldValue) => void`
	`20`	`+ value: FieldValue[]`
`20`	`21`	`} & FieldState<FieldValue[]>`
`21`	`22`	`meta: Partial<{`
`22`	`23`	// TODO: Make a diff of `FieldState` without all the functions

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ export type FieldArrayRenderProps = {`
`34`	`34`	`remove: (index: number) => any,`
`35`	`35`	`shift: () => any,`
`36`	`36`	`swap: (indexA: number, indexB: number) => void,`
`37`		`- unshift: (value: any) => void`
	`37`	`+ unshift: (value: any) => void,`
	`38`	`+ value: any[]`
`38`	`39`	`},`
`39`	`40`	`meta: Meta`
`40`	`41`	`}`

Comments

(0)