从 Angular 中的自定义表单组件访问 FormControl

Question

我的 Angular 应用程序中有一个自定义表单控件组件，它实现了ControlValueAccessor 接口。

但是，我想访问与我的组件关联的 FormControl 实例。我正在使用带有FormBuilder 的响应式表单，并使用formControlName 属性提供表单控制。

那么，我如何从我的自定义表单组件内部访问 FormControl 实例？

Answer 1

这个解决方案诞生于 Angular 存储库中的 the discussion。如果您对此问题感兴趣，请务必阅读或参与。

---

我研究了FormControlName 指令的代码，它启发了我编写以下解决方案：

@Component({
  selector: 'my-custom-form-component',
  templateUrl: './custom-form-component.html',
  providers: [{
    provide: NG_VALUE_ACCESSOR,
    useExisting: CustomFormComponent,
    multi: true
  }]
})
export class CustomFormComponent implements ControlValueAccessor, OnInit {

  @Input() formControlName: string;

  private control: AbstractControl;


  constructor (
    @Optional() @Host() @SkipSelf()
    private controlContainer: ControlContainer
  ) {
  }


  ngOnInit () {

    if (this.controlContainer) {
      if (this.formControlName) {
        this.control = this.controlContainer.control.get(this.formControlName);
      } else {
        console.warn('Missing FormControlName directive from host element of the component');
      }
    } else {
      console.warn('Can\'t find parent FormGroup directive');
    }

  }

}

我将父 FormGroup 注入组件，然后使用通过 formControlName 绑定获得的控件名称从中获取特定的 FormControl。

但是，请注意，此解决方案专为在主机元素上使用 FormControlName 指令的用例量身定制。它在其他情况下不起作用。为此，您将需要添加一些额外的逻辑。如果您认为这应该由 Angular 解决，请务必访问 the discussion。

Answer 2

通过[formControl] 指令绑定时，使用formControlName 作为输入参数不起作用。

这是一种无需任何输入参数即可双向工作的解决方案。

export class MyComponent implements AfterViewInit {

  private control: FormControl;

  constructor(
    private injector: Injector,
  ) { }

  // The form control is only set after initialization
  ngAfterViewInit(): void {
    const ngControl: NgControl = this.injector.get(NgControl, null);
    if (ngControl) {
      this.control = ngControl.control as FormControl;
    } else {
      // Component is missing form control binding
    }
  }
}

Answer 3

基于之前的答案和评论中的documentation，我认为这是基于ControlValueAccessor 的组件的最简洁的解决方案。

// No FormControl is passed as input to MyComponent
<my-component formControlName="myField"></my-component>

export class MyComponent implements AfterViewInit, ControlValueAccessor  {

  constructor(@Optional() @Self() public ngControl: NgControl) {
    if (ngControl != null) {
      // Setting the value accessor directly (instead of using
      // the providers) to avoid running into a circular import.
      ngControl.valueAccessor = this;
    }
  }

    ngAfterContentInit(): void {
       const control = this.ngControl && this.ngControl.control;
       if (control) {
          // FormControl should be available here
       }
    }
}

Answer 4

正如@Ritesh 已经在评论中所写，您可以将表单控件作为输入绑定传递：

<my-custom-form-component [control]="myForm.get('myField')" formControlName="myField">
</my-custom-form-component>

然后您可以像这样在自定义表单组件中获取表单控件实例：

@Input() control: FormControl;

Answer 5

以下是适用于 FormControlName 和 FormControl 输入的已接受答案的简化/清理版本：

export class CustomFormComponent implements ControlValueAccessor, OnInit {

  @Input() formControl: FormControl;

  @Input() formControlName: string;

  // get ahold of FormControl instance no matter formControl or formControlName is given.
  // If formControlName is given, then controlContainer.control is the parent FormGroup/FormArray instance.
  get control() {
    return this.formControl || this.controlContainer.control.get(this.formControlName);
  }

  constructor(private controlContainer: ControlContainer) { }
}