Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

useFieldArray improvement #5473

Merged
merged 4 commits into from
Jun 3, 2021
Merged

useFieldArray improvement #5473

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f9ab32
reduce function
bluebill1049 Jun 3, 2021
5f54d14
remove duplicated code
bluebill1049 Jun 3, 2021
808a7f5
Merge branch 'master' into improve-useFieldArray-1
bluebill1049 Jun 3, 2021
c76570c
replace set logic with custom register
bluebill1049 Jun 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion src/__tests__/useFieldArray/append.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,24 @@ describe('append', () => {
test: [{ value: '1' }],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{
criteriaMode: undefined,
fields: {
test: [
{
value: {
mount: true,
name: 'test.0.value',
ref: {
name: 'test.0.value',
},
value: '1',
},
},
],
},
names: ['test.0.value'],
},
);
});

Expand Down
19 changes: 18 additions & 1 deletion src/__tests__/useFieldArray/insert.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,24 @@ describe('insert', () => {
test: [{ value: '1' }],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{
criteriaMode: undefined,
fields: {
test: [
{
value: {
mount: true,
name: 'test.0.value',
ref: {
name: 'test.0.value',
},
value: '1',
},
},
],
},
names: ['test.0.value'],
},
);
});

Expand Down
29 changes: 28 additions & 1 deletion src/__tests__/useFieldArray/move.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,34 @@ describe('swap', () => {
test: [{ value: '2' }, { value: '1' }],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{
criteriaMode: undefined,
fields: {
test: [
{
value: {
mount: true,
name: 'test.1.value',
ref: {
name: 'test.1.value',
},
value: '2',
},
},
{
value: {
mount: true,
name: 'test.0.value',
ref: {
name: 'test.0.value',
},
value: '1',
},
},
],
},
names: ['test.0.value', 'test.1.value'],
},
);
});

Expand Down
19 changes: 18 additions & 1 deletion src/__tests__/useFieldArray/prepend.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,24 @@ describe('prepend', () => {
test: [{ value: '1' }],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{
criteriaMode: undefined,
fields: {
test: [
{
value: {
mount: true,
name: 'test.0.value',
ref: {
name: 'test.0.value',
},
value: '1',
},
},
],
},
names: ['test.0.value'],
},
);
});

Expand Down
2 changes: 1 addition & 1 deletion src/__tests__/useFieldArray/remove.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -965,7 +965,7 @@ describe('remove', () => {
test: [],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{ criteriaMode: undefined, fields: {}, names: ['test.0.value'] },
);
});

Expand Down
29 changes: 28 additions & 1 deletion src/__tests__/useFieldArray/swap.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,34 @@ describe('swap', () => {
test: [{ value: '2' }, { value: '1' }],
},
undefined,
{ criteriaMode: undefined, fields: {}, names: [] },
{
criteriaMode: undefined,
fields: {
test: [
{
value: {
mount: true,
name: 'test.1.value',
ref: {
name: 'test.1.value',
},
value: '2',
},
},
{
value: {
mount: true,
name: 'test.0.value',
ref: {
name: 'test.0.value',
},
value: '1',
},
},
],
},
names: ['test.0.value', 'test.1.value'],
},
);
});

Expand Down
3 changes: 1 addition & 2 deletions src/__tests__/useForm.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1082,7 +1082,7 @@ describe('useForm', () => {
sub: {
mount: true,
name: 'test.sub',
ref: { name: 'test.sub', value: 'test' },
ref: { name: 'test.sub' },
value: 'test',
},
},
Expand All @@ -1091,7 +1091,6 @@ describe('useForm', () => {
name: 'test1',
ref: {
name: 'test1',
value: 'test1',
},
value: 'test1',
},
Expand Down
33 changes: 10 additions & 23 deletions src/useFieldArray.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import get from './utils/get';
import insertAt from './utils/insert';
import isPrimitive from './utils/isPrimitive';
import isString from './utils/isString';
import isUndefined from './utils/isUndefined';
import moveArrayAt from './utils/move';
import omit from './utils/omit';
import prependAt from './utils/prepend';
Expand All @@ -29,8 +28,10 @@ import {
FieldErrors,
FieldPath,
FieldValues,
Path,
UseFieldArrayProps,
UseFieldArrayReturn,
UseFormRegister,
} from './types';
import { useFormContext } from './useFormContext';

Expand Down Expand Up @@ -64,6 +65,7 @@ export const useFieldArray = <
unregister,
shouldUnmount,
inFieldArrayActionRef,
register,
} = control || methods.control;

const [fields, setFields] = React.useState<
Expand All @@ -89,9 +91,7 @@ export const useFieldArray = <
>(
fields: T,
) =>
fields.map((field) =>
omit((field || {}) as Record<TKeyName, any>, keyName),
);
fields.map((field = {}) => omit(field as Record<TKeyName, any>, keyName));

const getCurrentFieldsValues = () => {
const values = get(getFieldsValues(fieldsRef), name, []);
Expand All @@ -115,15 +115,6 @@ export const useFieldArray = <
? options.focusName || `${name}.${options.focusIndex}`
: `${name}.${index}`;

const resetFields = <T>(index?: T) =>
convertToArrayPayload(index).forEach((currentIndex) =>
set(
fieldsRef.current,
`${name}${isUndefined(currentIndex) ? '' : `.${currentIndex}`}`,
isUndefined(currentIndex) ? [] : undefined,
),
);

const setFieldsAndNotify = (
fieldsValues: Partial<FieldArray<TFieldValues, TFieldArrayName>>[] = [],
) => setFields(mapIds(fieldsValues, keyName));
Expand Down Expand Up @@ -219,15 +210,10 @@ export const useFieldArray = <

Array.isArray(value)
? registerFieldArray(value, valueIndex, inputName)
: set(fieldsRef.current, inputName, {
_f: {
ref: {
name: inputName,
},
name: inputName,
value: isPrimitive(value) ? value : { ...value },
},
});
: (register as UseFormRegister<TFieldValues>)(
inputName as Path<TFieldValues>,
{ value },
);
}),
);

Expand Down Expand Up @@ -297,8 +283,9 @@ export const useFieldArray = <
const updatedFieldArrayValues: Partial<
FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>
>[] = removeArrayAt(getCurrentFieldsValues(), index);
resetFields(index);

setFieldsAndNotify(updatedFieldArrayValues);

batchStateUpdate(
removeArrayAt,
{
Expand Down
8 changes: 1 addition & 7 deletions src/useForm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1065,13 +1065,7 @@ export function useForm<
(isPrimitive(value) ||
(isWeb && (value instanceof FileList || value instanceof Date)))
) {
set(fieldsRef.current, name, {
_f: {
ref: { name, value },
value,
name,
},
});
register(name as Path<TFieldValues>, { value } as RegisterOptions);
}

if (Array.isArray(value) || isObject(value)) {
Expand Down