Skip to main content

FormNode

Defined in: form/types/nodes.ts:33

Общий контракт ноды формы — поля, группы и массива под-форм.

Значением нода не владеет: источник истины — модель (model.$.<путь>), нода держит состояние взаимодействия (touched, dirty), доступность и замечания валидации.

Example​

const { form } = createForm<{ email: string }>({ initial: { email: '' } });
form.email.setValue('user@mail.com');
form.email.markAsTouched();
form.valid.value; // true — замечаний нет

Extended by​

Type Parameters​

T​

T

Значение ноды

Methods​

clearIssues()​

clearIssues(): void;

Defined in: form/types/nodes.ts:72

Returns​

void


disable()​

disable(): void;

Defined in: form/types/nodes.ts:69

Returns​

void


enable()​

enable(): void;

Defined in: form/types/nodes.ts:68

Returns​

void


getValue()​

getValue(): T;

Defined in: form/types/nodes.ts:57

Значение без подписки.

Returns​

T


markAsTouched()​

markAsTouched(): void;

Defined in: form/types/nodes.ts:66

Returns​

void


markAsUntouched()​

markAsUntouched(): void;

Defined in: form/types/nodes.ts:67

Returns​

void


reset()​

reset(value?): void;

Defined in: form/types/nodes.ts:65

Вернуть значение и состояние к начальным; с аргументом — к переданному значению. В цель compute значение не пишется (кроме явного reset(значение) самого поля): ею владеет поведение — сбрасывается только состояние.

Parameters​

value?​

T

Returns​

void


setIssues()​

setIssues(issues): void;

Defined in: form/types/nodes.ts:71

Поставить замечания извне (ответ сервера, своя проверка).

Parameters​

issues​

readonly ValidationIssue[]

Returns​

void


setValue()​

setValue(value): void;

Defined in: form/types/nodes.ts:59

Записать значение в модель.

Parameters​

value​

T

Returns​

void

Properties​

dirty​

readonly dirty: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:47

Значение меняли после создания или сброса.


disabled​

readonly disabled: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:43

Нода отключена: её замечания сняты, в проверку она не входит.


invalid​

readonly invalid: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:39

Есть блокирующие замечания; нода включена и не ждёт проверки.


issues​

readonly issues: ReadonlySignal<readonly ValidationIssue[]>;

Defined in: form/types/nodes.ts:49

Замечания ноды; у группы и массива — свои и всех детей.


ownIssues​

readonly ownIssues: ReadonlySignal<readonly ValidationIssue[]>;

Defined in: form/types/nodes.ts:54

Собственные замечания ноды — без замечаний детей: у группы и массива это правила на их ручке (minLength массива, cross группы), у поля — то же, что issues.


pending​

readonly pending: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:41

Идёт асинхронная проверка.


touched​

readonly touched: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:45

Пользователь взаимодействовал с нодой.


valid​

readonly valid: ReadonlySignal<boolean>;

Defined in: form/types/nodes.ts:37

Замечаний, которые блокируют отправку, нет; нода включена и не ждёт проверки.


value​

readonly value: ReadonlySignal<T>;

Defined in: form/types/nodes.ts:35

Текущее значение.