Interface

BaseCheckedField

@ng-forge/dynamic-forms

Signature

interface BaseCheckedField<
  TProps,
  TMeta extends FieldMeta = FieldMeta,
  TNullable extends boolean = false
>
  extends FieldDef<TProps, TMeta>, FieldWithValidation

Type Parameters

NameConstraintDefaultDescription
TProps---
TMetaFieldMetaFieldMeta-
TNullablebooleanfalse-

Properties

NameTypeDescription
value ?(TNullable extends true ? boolean | null : boolean) | undefined-
placeholder ?DynamicText | undefined

Placeholder text displayed when the field is empty. Supports static strings, Observables, and Signals for dynamic content.

required ?boolean | undefined-
nullable ?TNullable | undefined

Whether the field accepts null as a valid value.

When true, value may be null and an omitted value resolves to null (rather than the type-specific empty default of false). Orthogonal to required.

The data model is decoupled from the UI: a null value is a legitimate "undecided" state at the storage / OpenAPI layer. Whether the rendered checkbox shows an indeterminate visual is controlled separately via props.indeterminate and is not driven by this flag.