feat(cdk:forms): formArray supports clearControls (#1490)

IDuxFE · Mar 6, 2023 · 1cd4dcc · 1cd4dcc
1 parent 1f1484f
commit 1cd4dcc
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/packages/cdk/forms/__tests__/formArray.spec.ts b/packages/cdk/forms/__tests__/formArray.spec.ts
@@ -95,6 +95,16 @@ describe('formArray.ts', () => {
       expect(array.blurred.value).toEqual(false)
     })
 
+    test('clearControls work', async () => {
+      expect(array.length.value).toEqual(1)
+      expect(array.getValue()).toEqual([basicValue])
+
+      array.clearControls()
+
+      expect(array.length.value).toEqual(0)
+      expect(array.getValue()).toEqual([])
+    })
+
     test('setControl work', async () => {
       expect(array.getValue()).toEqual([basicValue])
       const group = new FormGroup<BasicGroup>({

diff --git a/packages/cdk/forms/docs/Api.zh.md b/packages/cdk/forms/docs/Api.zh.md
@@ -534,6 +534,10 @@ export class FormArray<T = any> extends AbstractControl<T[]> {
      * @param index 删除控件的下标
      */
     removeAt(index: number): void;
+    /**
+     * 清空数组中的所有子空间
+     */
+    clearControls(): void;
     /**
      * 替换数组中给定 `index` 处现有的子控件
      *

diff --git a/packages/cdk/forms/src/models/formArray.ts b/packages/cdk/forms/src/models/formArray.ts
@@ -107,6 +107,12 @@ export class FormArray<T = any> extends AbstractControl<T[]> {
     controls.splice(index, 1)
     this._controls.value = controls
   }
+  /**
+   * Empties out the controls.
+   */
+  clearControls(): void {
+    this._controls.value = []
+  }
 
   /**
    * Replace an existing control.