Interface

WrapperFieldInputs

@ng-forge/dynamic-forms

Input shape passed to a wrapper component via the fieldInputs input.

Carries the wrapped field's mapper outputs plus an optional field read-only view. Wrappers reached through a container path (which has no FieldTree of its own) receive fieldInputs === undefined, so any wrapper that reads fieldInputs.field must guard for it.

Mappers must emit new rawInputs objects per tick rather than mutating the previous one — this bag is a shallow spread, so mutations to shared nested values leak to downstream wrappers.

Signature

interface WrapperFieldInputs

Properties

NameTypeDescription
key string-
type ?string | undefinedField-type discriminant (mirrors FieldDef.type) — useful for kind-aware addons.
label ?string | undefined-
placeholder ?string | undefined-
className ?string | undefined-
props ?Record<string, unknown> | undefined-
validationMessages ?Record<string, string> | undefined-
defaultValidationMessages ?Record<string, string> | undefined-
field ?ReadonlyFieldTree<unknown> | undefined-
setValue ?((next: unknown) => void) | undefined

Write a value into the wrapped field's tree. Provided by buildFieldInputs when a FieldTree is present. Addons (e.g., prime-button presets) use this to mutate the host field; wrappers should treat the field as read-only.

packages/dynamic-forms/src/lib/wrappers/wrapper-field-inputs.ts:15