Allow fields to be removed manually via removeFields() in useFormContext

witbybit · Aug 16, 2022 · 3950bfb · 3950bfb
1 parent 4e7e48e
commit 3950bfb
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/src/FormProvider.tsx b/src/FormProvider.tsx
@@ -40,6 +40,7 @@ import {
   IFormContextFieldInput,
   IIsDirtyProps,
   InitialValues,
+  IRemoveFieldParams,
 } from './types';
 import {
   getPathInObj,
@@ -381,7 +382,34 @@ export function useFormContext() {
     [formId]
   );
 
-  return { getValue, setValue, getValues, checkIsDirty };
+  const removeFields = useRecoilCallback<any, any>(
+    ({ reset }) =>
+      (params: IRemoveFieldParams) => {
+        for (const fieldName of params.fieldNames) {
+          if (typeof fieldName === 'string') {
+            reset(
+              fieldAtomFamily({
+                ancestors: [],
+                formId,
+                name: fieldName,
+                type: 'field',
+              })
+            );
+          } else {
+            reset(
+              fieldAtomFamily({
+                ancestors: fieldName.ancestors ?? [],
+                formId,
+                name: fieldName.name,
+                type: 'field',
+              })
+            );
+          }
+        }
+      }
+  );
+
+  return { getValue, setValue, getValues, checkIsDirty, removeFields };
 }
 
 export function useFieldArray(props: IFieldArrayProps) {

diff --git a/src/types.ts b/src/types.ts
@@ -29,6 +29,13 @@ export interface FinalValues {
   extraInfos: any;
 }
 
+export interface IRemoveFieldParams {
+  fieldNames: (
+    | string
+    | { ancestors?: { name: string; rowId: number }[]; name: string }
+  )[];
+}
+
 export interface IFieldWatchParams {
   fieldNames: (
     | string