Spec-Zone.ru › Angular

FormValueControl

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

API

interface FormValueControl<TValue> extends FormUiControl<TValue> {
  readonly value: ModelSignal<TValue>;
  readonly checked?: 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;
}

value

ModelSignal<TValue>

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

checked

undefined

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

errors

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

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

disabled

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

disabledReasons

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

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

readonly

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

hidden

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

invalid

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

pending

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

touched

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

dirty

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

name

InputSignal<string> | InputSignalWithTransform<string, unknown> | undefined

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

required

InputSignal<boolean> | InputSignalWithTransform<boolean, unknown> | undefined

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

min

InputSignal<NonNullable<TValue> | undefined> | InputSignalWithTransform<NonNullable<TValue> | undefined, unknown> | undefined

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

minLength

InputSignal<number | undefined> | InputSignalWithTransform<number | undefined, unknown> | undefined

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

max

InputSignal<NonNullable<TValue> | undefined> | InputSignalWithTransform<NonNullable<TValue> | undefined, unknown> | undefined

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

maxLength

InputSignal<number | undefined> | InputSignalWithTransform<number | undefined, unknown> | undefined

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

pattern

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

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

touch

OutputRef<void> | undefined

Выходное событие, испускаемое при взаимодействии с элементом управления.

focus

void

Устанавливает фокус на элементе управления пользовательского интерфейса.

Если метод focus не реализован, Signal Forms попытается установить фокус на хост-элементе при запросе на установку фокуса на этот элемент управления.

@paramoptionsFocusOptions | undefined
@returnsvoid

reset

void

Сбрасывает элемент управления пользовательского интерфейса в исходное состояние.

@returnsvoid

Описание

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

Многие свойства, объявленные в этом контракте, являются необязательными. Их не обязательно реализовывать, но если они реализованы, их значения будут синхронизироваться с состоянием поля, привязанного к директиве Field.

Super-powered by Google ©2010–2025.
Code licensed under an MIT-style License. Documentation licensed under CC BY 4.0.
https://angular.dev/api/forms/signals/FormValueControl

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API