RFC: useFieldArray replace method

[bluebill1049]

Context

Developers will be required to reset a field array with reset API, this not only affects a single field array but the entire form, which could lead to unexpected behavior, you can achieve similar behavior with setValue with field array name. We want to bring a new API replace to make API more declarative and easier for developers who just want to update and replace a specific field array.

Props

• declarative API for reset a single field array
• more performant than reset the entire form

Cons

• increase in package bundle size.

Proposal

const { control } = useForm({
  defaultValues: {
    test: [{ value: 'lorem' }, { value: 'ipsum' }]
  }
});
const { fields, replace } = useFieldArray({ 
  control, 
  name: 'test'
});

const handleFullyReplacement = (): void => {
  // remove old and set fully new values
  replace([{ value: 'dolor' }, { value: 'sit' }, { value: 'amet' }]);
}

PR

#6304

cc @jorisre @kotarella1110 @barrymay

[bluebill1049]

PR is merged.

[OlehDutchenko]

Thanks! 👍

[bluebill1049]

Thanks to @dutchenkoOleg for your contribution 🙏

[bluebill1049]

released and the doc is updated too.

[MedinaGitHub]

@bluebill1049 That method doesn't exist on Version 6 =S I'm using 6.15.5 version. But it was added to the legacy doc

[bluebill1049]

could you send an issue at the documentation repo? let's fix this.