react-hook-form
Version:
Performant, flexible and extensible forms library for React Hooks
36 lines • 1.12 kB
TypeScript
import type { FieldArrayPath, FieldArrayProps, FieldValues } from './types';
/**
* Component based on `useFieldArray` hook to work with controlled component.
*
* @example
* ```tsx
* function App() {
* const { control, register } = useForm<FormValues>({
* defaultValues: {
* test: [
* {
* value: '',
* },
* ],
* },
* });
*
* return (
* <form>
* <FieldArray
* control={control}
* name="test"
* render={({ fields }) =>
* fields.map((field, index) => (
* <input key={field.id} {...register(`test.${index}.value`)} />
* ))
* }
* />
* </form>
* );
* }
* ```
*/
declare const FieldArray: <TFieldValues extends FieldValues = FieldValues, TName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = "id">(props: FieldArrayProps<TFieldValues, TName, TKeyName>) => import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>;
export { FieldArray };
//# sourceMappingURL=fieldArray.d.ts.map