Skip to content

Commit 3f38974

Browse files
authored
🧄 feat: disable useFieldArray fields (#13535)
* feature: disable useFieldArray fields * update api
1 parent 62be736 commit 3f38974

4 files changed

Lines changed: 33 additions & 7 deletions

File tree

‎reports/api-extractor.md.api.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,9 @@ export type UseFieldArrayReturn<TFieldValues extends FieldValues = FieldValues,
695695
insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>;
696696
update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>;
697697
replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>;
698-
fields: FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>[];
698+
fields: (FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName> & {
699+
disabled?: boolean;
700+
})[];
699701
};
700702

701703
// @public

‎src/__tests__/useFieldArray.test.tsx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5268,3 +5268,25 @@ it('should not modify form values when disabled methods are called', () => {
52685268
expect(result.current.fieldArray.fields).toEqual([]);
52695269
expect(result.current.form.getValues('items')).toEqual([]);
52705270
});
5271+
5272+
it('should propagate disabled to field objects when disabled is set', () => {
5273+
type FormValues = { items: { value: string }[] };
5274+
5275+
const { result } = renderHook(() => {
5276+
const form = useForm<FormValues>({
5277+
defaultValues: { items: [{ value: 'a' }, { value: 'b' }] },
5278+
});
5279+
const fieldArray = useFieldArray({
5280+
control: form.control,
5281+
name: 'items',
5282+
disabled: true,
5283+
});
5284+
return { form, fieldArray };
5285+
});
5286+
5287+
expect(result.current.fieldArray.fields).toHaveLength(2);
5288+
expect(result.current.fieldArray.fields[0].disabled).toBe(true);
5289+
expect(result.current.fieldArray.fields[1].disabled).toBe(true);
5290+
expect(result.current.fieldArray.fields[0].value).toBe('a');
5291+
expect(result.current.fieldArray.fields[1].value).toBe('b');
5292+
});

‎src/types/fieldArray.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,5 +278,7 @@ export type UseFieldArrayReturn<
278278
insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>;
279279
update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>;
280280
replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>;
281-
fields: FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>[];
281+
fields: (FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName> & {
282+
disabled?: boolean;
283+
})[];
282284
};

‎src/useFieldArray.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import convertToArrayPayload from './utils/convertToArrayPayload';
1313
import fillEmptyArray from './utils/fillEmptyArray';
1414
import get from './utils/get';
1515
import insertAt from './utils/insert';
16+
import isBoolean from './utils/isBoolean';
1617
import isEmptyObject from './utils/isEmptyObject';
1718
import moveArrayAt from './utils/move';
1819
import prependAt from './utils/prepend';
@@ -105,11 +106,9 @@ export function useFieldArray<
105106
shouldUnregister,
106107
rules,
107108
} = props;
108-
const [fields, setFields] = React.useState(
109-
disabled ? [] : control._getFieldArray(name),
110-
);
109+
const [fields, setFields] = React.useState(control._getFieldArray(name));
111110
const ids = React.useRef<string[]>(
112-
disabled ? [] : control._getFieldArray(name).map(generateId),
111+
control._getFieldArray(name).map(generateId),
113112
);
114113

115114
const _actioned = React.useRef(false);
@@ -523,9 +522,10 @@ export function useFieldArray<
523522
() =>
524523
fields.map((field, index) => ({
525524
...field,
525+
...(isBoolean(disabled) ? { disabled } : {}),
526526
[keyName]: ids.current[index] || generateId(),
527527
})) as FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>[],
528-
[fields, keyName],
528+
[fields, keyName, disabled],
529529
),
530530
};
531531
}

0 commit comments

Comments
 (0)