CheckedFieldComponent
@ng-forge/dynamic-forms
Signature
type CheckedFieldComponent<T extends BaseCheckedField<Record<string, unknown> | unknown>> = Prettify<
WithInputSignals<Omit<T, ExcludedKeys>>
>;Type Parameters
| Name | Constraint | Default | Description |
|---|---|---|---|
T | BaseCheckedField<Record<string, unknown> | unknown> | - | - |
Properties
| Name | Type | Description |
|---|---|---|
key | WithInputSignals<Omit<T, ExcludedKeys>>["key"] | Unique field identifier used for form binding and value tracking. This key is used to associate the field with form values and must be unique within the form. It follows object property naming conventions. |
label | WithInputSignals<Omit<T, ExcludedKeys>>["label"] | Human-readable field label displayed to users. Provides accessible labeling for form fields and is typically displayed above or beside the field input. Supports static strings, translation keys, Observables, and Signals for dynamic content. |
props | WithInputSignals<Omit<T, ExcludedKeys>>["props"] | Field-specific properties and configuration options. Contains type-specific configuration that varies based on the field type. The shape is defined by the TProps generic parameter. |
meta | WithInputSignals<Omit<T, ExcludedKeys>>["meta"] | Native HTML attributes to pass through to the underlying element. Contains attributes that are applied directly to the native input/element. Useful for accessibility, autocomplete hints, and custom attributes. The shape is defined by the TMeta generic parameter, which extends FieldMeta. |
className | WithInputSignals<Omit<T, ExcludedKeys>>["className"] | Additional CSS classes for custom styling. Space-separated string of CSS class names that will be applied to the field container for custom styling. |
tabIndex | WithInputSignals<Omit<T, ExcludedKeys>>["tabIndex"] | Tab index for keyboard navigation. Controls the order in which fields receive focus when navigating with the Tab key. Follows standard HTML tabindex behavior. |
placeholder | WithInputSignals<Omit<T, ExcludedKeys>>["placeholder"] | Placeholder text displayed when the field is empty. Supports static strings, Observables, and Signals for dynamic content. |
packages/dynamic-forms/src/lib/definitions/base/base-checked-field.ts:45