EvaluatedFormElement
API / @publicodes/forms / EvaluatedFormElement
type EvaluatedFormElement =
| EvaluatedCheckbox
| EvaluatedStringInput
| EvaluatedNumberInput
| EvaluatedRadioGroup
| EvaluatedSelect
| EvaluatedTextarea;
Defined in: evaluatedFormElement.ts:83
Represents the different types of form elements that can be generated from Publicodes rules.
Each evaluated form element includes common properties:
applicable
: Whether the field should be shown based on applicability rulesrequired
: Whether user input is required for this fieldanswered
: Whether the field has been answered/filledvalue
: The current value of the field (in the situation)defaultValue
: The default value of the field if not answered
Example
// Example of an evaluated number input
const evaluatedField: EvaluatedFormElement = {
element: 'input',
type: 'number',
id: 'salary',
label: 'Monthly salary',
applicable: true,
required: true,
answered: false,
value: 3000,
unit: '€',
defaultValue: 2500
}
See
- getEvaluatedFormElement - Function to retrieve evaluated form elements
- FormElement - Type definition for form elements