FormCheckboxControl — Angular

Контракт для элемента управления формы, редактирующего логическое поле флажка FieldTree. Любой компонент, реализующий этот контракт, можно использовать с директивой Field.

API

interface FormCheckboxControl extends FormUiControl<boolean> {
  readonly checked: ModelSignal<boolean>;
  readonly value?: undefined;
  readonly override errors?: InputSignal<readonly WithOptionalFieldTree[]> | InputSignalWithTransform<readonly WithOptionalFieldTree[], unknown> | undefined;
  readonly override disabled?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override disabledReasons?: InputSignal<readonly WithOptionalFieldTree<DisabledReason>[]> | InputSignalWithTransform<readonly WithOptionalFieldTree<DisabledReason>[], unknown> | undefined;
  readonly override readonly?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override hidden?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override invalid?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override pending?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override touched?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override dirty?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override name?: InputSignal<string> | InputSignalWithTransform<string, unknown> | undefined;
  readonly override required?: InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined;
  readonly override min?: InputSignal<NonNullable<TValue> | undefined> | InputSignalWithTransform<NonNullable<TValue> | undefined, unknown> | undefined;
  readonly override minLength?: InputSignal<number | undefined> | InputSignalWithTransform<number | undefined, unknown> | undefined;
  readonly override max?: InputSignal<NonNullable<TValue> | undefined> | InputSignalWithTransform<NonNullable<TValue> | undefined, unknown> | undefined;
  readonly override maxLength?: InputSignal<number | undefined> | InputSignalWithTransform<number | undefined, unknown> | undefined;
  readonly override pattern?: InputSignal<readonly RegExp[]> | InputSignalWithTransform<readonly RegExp[], unknown> | undefined;
  readonly override touch?: OutputRef<void> | undefined;
  optional override focus(options?: FocusOptions | undefined): void;
  optional override reset(): void;
}

checked

ModelSignal<boolean>

Свойство checked — единственное обязательное свойство этого контракта. Компонент, который должен интегрироваться с директивой Field, обязан предоставлять model(), синхронизируемое со значением связанного FieldTree.

value

undefined

Реализующий компонент не должен определять свойство value. Оно предназначено для компонентов, которые должны интегрироваться с директивой Field в качестве стандартного поля ввода.

errors

InputSignal<readonly WithOptionalFieldTree[]> | InputSignalWithTransform<readonly WithOptionalFieldTree[], unknown> | undefined

Входное свойство для получения ошибок поля. Если оно реализовано, директива Field автоматически привяжет к этому свойству ошибки связанного поля.