ReadonlyFieldState — Angular

Представление состояния FieldTree только для чтения.

API

interface ReadonlyFieldState<TValue, TKey extends string | number = string | number> {
  readonly fieldTree: ReadonlyFieldTree<unknown, TKey>;
  readonly value: Signal<TValue>;
  readonly controlValue: Signal<TValue>;
  readonly disabled: Signal<boolean>;
  readonly max: Signal<NonNullable<TValue> | undefined> | undefined;
  readonly maxLength: Signal<number | undefined> | undefined;
  readonly min: Signal<NonNullable<TValue> | undefined> | undefined;
  readonly minLength: Signal<number | undefined> | undefined;
  readonly name: Signal<string>;
  readonly pattern: Signal<readonly RegExp[]>;
  readonly readonly: Signal<boolean>;
  readonly required: Signal<boolean>;
  readonly touched: Signal<boolean>;
  readonly dirty: Signal<boolean>;
  readonly hidden: Signal<boolean>;
  readonly disabledReasons: Signal<readonly DisabledReason[]>;
  readonly errors: Signal<WithFieldTree[]>;
  readonly errorSummary: Signal<WithFieldTree[]>;
  readonly valid: Signal<boolean>;
  readonly invalid: Signal<boolean>;
  readonly pending: Signal<boolean>;
  readonly submitting: Signal<boolean>;
  readonly keyInParent: Signal<TKey>;
  readonly formFieldBindings: Signal<readonly FormFieldBinding[]>;
  metadata<M>(key: MetadataKey<M, any, any>): M | undefined;
  hasMetadata(key: MetadataKey<any, any, any>): boolean;
  focusBoundControl(options?: FocusOptions | undefined): void;
}

fieldTree

ReadonlyFieldTree<unknown, TKey>

FieldTree, связанное с этим состоянием поля.

value

Signal<TValue>

Записываемый сигнал, содержащий значение этого поля.

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

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

controlValue

Signal<TValue>

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

Он отличается от value тем, что на него не распространяется задержка обновления, поэтому он используется для буферизации обновлений элемента управления поля с задержкой. Он также не учитывает controlValue дочерних элементов.

disabled

Signal<boolean>

Сигнал, указывающий, отключено ли в данный момент поле.

max

Signal<NonNullable<TValue> | undefined> | undefined

Сигнал, указывающий максимальное значение поля, если оно применимо.

Применяется к <input> с числовым атрибутом или атрибутом даты type, а также к пользовательским элементам управления.

maxLength

Signal<number | undefined> | undefined

Сигнал, указывающий максимальную длину строки поля, если она применима.

Применяется к <input>, <textarea> и пользовательским элементам управления.

min

Signal<NonNullable<TValue> | undefined> | undefined

Сигнал, указывающий минимальное значение поля, если оно применимо.

minLength

Signal<number | undefined> | undefined

Сигнал, указывающий минимальную длину строки поля, если она применима.

Применяется к <input>, <textarea> и пользовательским элементам управления.

name

Signal<string>

Сигнал с уникальным именем поля, по умолчанию основанным на имени родительского поля.

pattern

Signal<readonly RegExp[]>

Сигнал, указывающий шаблоны, которым должно соответствовать поле.

readonly

Signal<boolean>

Сигнал, указывающий, доступно ли в данный момент поле только для чтения.

required

Signal<boolean>

Сигнал, указывающий, является ли поле обязательным.

touched

Signal<boolean>

Сигнал, указывающий, взаимодействовал ли пользователь с полем.

dirty

Signal<boolean>

Сигнал, указывающий, изменил ли пользователь значение поля.

hidden

Signal<boolean>

Сигнал, указывающий, скрыто ли поле.

При определении состояний валидности, взаимодействия и изменения скрытое поле игнорируется.

Примечание. Это не скрывает поле в шаблоне; это необходимо сделать вручную.

@if (!field.hidden()) {
  ...
}

disabledReasons

Signal<readonly DisabledReason[]>

errors

Signal<WithFieldTree[]>

errorSummary

Signal<WithFieldTree[]>

Сигнал, содержащий errors этого поля и его потомков.

valid

Signal<boolean>

Сигнал, указывающий, является ли значение поля в данный момент допустимым.

Примечание. valid() — это не то же самое, что !invalid().

valid() — true, если ошибок проверки нет и нет ожидающих проверок.
invalid() — true, если есть ошибки проверки, независимо от ожидающих проверок.

Например, рассмотрим ситуацию, когда у поля есть 3 проверки: 2 из них не обнаружили ошибок, а 1 ещё выполняется. В этом случае valid() — false из-за ожидающей проверки. Однако invalid() также false, поскольку ошибок нет.

invalid

Signal<boolean>

Сигнал, указывающий, является ли значение поля в данный момент недопустимым.

Примечание. invalid() — это не то же самое, что !valid().

invalid() — true, если есть ошибки проверки, независимо от ожидающих проверок.
valid() — true, если ошибок проверки нет и нет ожидающих проверок.

Например, рассмотрим ситуацию, когда у поля есть 3 проверки: 2 из них не обнаружили ошибок, а 1 ещё выполняется. В этом случае invalid() — false, поскольку ошибок нет. Однако valid() также false из-за ожидающей проверки.

pending

Signal<boolean>

Указывает, есть ли у этого поля проверки, выполнение которых ещё не завершено.

submitting

Signal<boolean>

Сигнал, указывающий, выполняется ли в данный момент отправка поля.

keyInParent

Signal<TKey>

Ключ свойства в родительском поле, по которому хранится это поле. Например, если родительское поле содержит массив, то это индекс данного поля в массиве.

formFieldBindings

Signal<readonly FormFieldBinding[]>

Директивы FormField, связывающие это поле с элементом управления пользовательского интерфейса.

metadata

M | undefined

Читает значение метаданных поля.

@paramkeyMetadataKey<M, any, any>

Ключ метаданных для чтения.

@returnsM | undefined

hasMetadata

boolean

Проверяет, существует ли значение метаданных у поля.

@paramkeyMetadataKey<any, any, any>

Ключ метаданных для проверки.

@returnsboolean

focusBoundControl

void

Устанавливает фокус на первый элемент управления пользовательского интерфейса в DOM, связанный с этим состоянием поля. Если связанного элемента управления нет, ничего не делает.

@paramoptionsFocusOptions | undefined

Необязательные параметры фокуса, передаваемые встроенному методу focus().

@returnsvoid