Interface: FieldApi<V>

Defined in: types.ts:297

Type Parameters

Type Parameter	Default type
V	unknown

Properties

calculated

calculated: boolean;

Defined in: types.ts:313

---

choices

choices: ResolvedChoice[];

Defined in: types.ts:317

---

dirty

dirty: boolean;

Defined in: types.ts:305

---

element

element: Element;

Defined in: types.ts:299

---

errors

errors: FieldIssue[];

Defined in: types.ts:307

Issues the user is currently allowed to see (docs/06 §7), not every issue.

---

guidance

guidance: string;

Defined in: types.ts:316

---

hint

hint: string;

Defined in: types.ts:315

---

ids

ids: FieldIds;

Defined in: types.ts:318

---

infos

infos: FieldIssue[];

Defined in: types.ts:309

---

inputProps

inputProps: InputA11yProps;

Defined in: types.ts:319

---

label

label: string;

Defined in: types.ts:314

---

path

path: string;

Defined in: types.ts:298

---

readonly

readonly: boolean;

Defined in: types.ts:312

---

relevant

relevant: boolean;

Defined in: types.ts:310

---

required

required: boolean;

Defined in: types.ts:311

---

state

state: FieldState;

Defined in: types.ts:321

The raw engine projection, including issues that are not shown yet.

---

touched

touched: boolean;

Defined in: types.ts:304

---

value

value: V | undefined;

Defined in: types.ts:300

---

warnings

warnings: FieldIssue[];

Defined in: types.ts:308

Methods

blur()

blur(): void;

Defined in: types.ts:303

Marks the field as blurred, which is what reveals required errors.

Returns

void

---

setValue()

setValue(value): void;

Defined in: types.ts:301

Parameters

Parameter	Type
value	V | undefined

Returns

void