Search code examples
angulardrag-and-dropangular-cdk

Draggable formGroups in formArray (reactive forms)


In angular drag-drop module, they provided documentation for the moveItemInArray() function, by using this we can only drag content in an array only. but, how we could shuffle (formGroups/formControls) in formArray?

Even I tried this moveItemInFormArray() function, as mentioned here https://github.com/angular/angular/issues/27171. but I can not make it work.

groupDrag.component.html

    <form [formGroup]="exampleForm">
      <div formArrayName="formUnits" cdkDropList (cdkDropListDropped)="drop($event)" *ngFor="let unit of exampleForm.controls.formUnits.controls; let i=index" class="rowGroup">
        <div [formGroupName]="i" class="basic-container" cdkDrag>
          <div class="row row-container" >
            <button type="button" class="drag-handle" mat-icon-button cdkDragHandle>
              <mat-icon>unfold_more</mat-icon>
            </button>

            <!-- label input field -->
            <mat-form-field  class="col-lg-4"> 
              <input matInput placeholder="Please enter label without spaces" formControlName="label" required>  
            </mat-form-field>

            <!-- options input field -->
              <mat-form-field  class="col-lg-3"> 
                <input matInput placeholder="Enter Placeholdertext" formControlName="placeholder">
             </mat-form-field>

          </div>
        </div>
      </div>
    </form>

groupDrag.component.ts

drop(event: CdkDragDrop<FormGroup[]>) {
  console.log('drop event triggers')
  this.formArray = this.exampleForm.get('formUnits') as FormArray;
  const from = event.previousIndex;
  const to = event.currentIndex;
  this.moveItemInFormArray(this.formArray, from, to)
}

/**
* Moves an item in a FormArray to another position.
* @param formArray FormArray instance in which to move the item.
* @param fromIndex Starting index of the item.
* @param toIndex Index to which he item should be moved.
*/
moveItemInFormArray(formArray: FormArray, fromIndex: number, toIndex: number): void {
  const from = this.clamp(fromIndex, formArray.length - 1);
  const to = this.clamp(toIndex, formArray.length - 1);

  if (from === to) {
    return;
  }

  const delta = from > to ? 1 : -1;
  for (let i = from; i * delta < to * delta; i += delta) {
    const previous = formArray.at(i);
    const current = formArray.at(i + delta);
    formArray.setControl(i, current);
    formArray.setControl(i + delta, previous);
  }
}

/** Clamps a number between zero and a maximum. */
clamp(value: number, max: number): number {
  return Math.max(0, Math.min(max, value));
}

Solution

  • This is my working solution

    in component.html

        <form [formGroup]="exampleForm">
          <div cdkDropList (cdkDropListDropped)="drop($event)">
            <div formArrayName="formUnits" class="rowGroup"
              *ngFor="let unit of exampleForm.controls.formUnits.controls; let i=index"  
               cdkDrag>
              <div [formGroupName]="i" class="basic-container" cdkDrag>
                <div class="row row-container" >
                  <button type="button" class="drag-handle" mat-icon-button cdkDragHandle>
                    <mat-icon>unfold_more</mat-icon>
                  </button>
    
                  <!-- label input field -->
                  <mat-form-field  class="col-lg-4"> 
                    <input matInput placeholder="Please enter label without spaces" 
                    formControlName="label" required>  
                  </mat-form-field>
    
                  <!-- options input field -->
                  <mat-form-field  class="col-lg-3"> 
                    <input matInput placeholder="Enter Placeholdertext" formControlName="placeholder">
                 </mat-form-field>
    
              </div>
            </div>
          </div>
        </div>
       </form>
    

    in component.ts file

      drop(event: CdkDragDrop<string[]>) {
        this.formArray = this.exampleForm.get('formUnits') as FormArray;
        const from = event.previousIndex;
        const to = event.currentIndex;
        this.moveItemInFormArray(this.formArray, from, to);
      }
    
      /**
     * Moves an item in a FormArray to another position.
     * @param formArray FormArray instance in which to move the item.
     * @param fromIndex Starting index of the item.
     * @param toIndex Index to which he item should be moved.
     */
      moveItemInFormArray(formArray: FormArray, fromIndex: number, toIndex: number): void {
        const from = this.clamp(fromIndex, formArray.length - 1);
        const to = this.clamp(toIndex, formArray.length - 1);
    
        if (from === to) {
          return;
        }
    
        const previous = formArray.at(from);
        const current = formArray.at(to);
        formArray.setControl(to, previous);
        formArray.setControl(from, current);
      }
    
      /** Clamps a number between zero and a maximum. */
      clamp(value: number, max: number): number {
        return Math.max(0, Math.min(max, value));
      }