FieldSetRange
Overview
Composite field that renders a pair of sub-fields for the lower and upper boundaries of a range, deriving their field names from the parent field name combined with the configured suffixes. Validates that the lower bound does not exceed the upper bound.
Theme entry: FieldSetRange
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| iconOverride | Object | null | A partial icon registry ({ [componentName]: { [iconName]: { component, props } } }) merged with inherited and default icon entries; scopes icon overrides to this component and its descendants. | |
| name | String | yes | The field name, used as the path to look up and store the value in the form state. | |
| formModelName | String | undefined | The name of the form model for configuration lookup; usually provided by a parent field renderer. | |
| clearServerErrorDependents | Array | () => [] | Other fields whose server errors should be cleared when this field's value changes. | |
| validationDependencies | Array | () => [] | Other field paths this field depends on; their values are passed to validation and required functions. | |
| readOnly | Boolean | false | Whether the field is read-only; disables editing and skips required validation. | |
| required | Boolean | null | Whether the field is required. | |
| requiredMessage | String | "This field is required." | Error message shown when a required field is left empty. | |
| shouldRequireFn | Function | null | Custom function called with resolved field dependency values; determines whether the field should be required. | |
| isRequiredViolation | Function | null | Custom function called with the current field value; checks whether the value violates the required rule. Defaults to rejecting null, undefined, empty string, false, and 0. | |
| validate | Function | null | Custom validation function called with the current field value and resolved field dependency values; should return true when valid or an error message string when invalid. | |
| label | String | null | The label shown next to the field; defaults to the field name when omitted. | |
| help | String | "" | Help text displayed alongside the field. | |
| modelValue | String|Number|Boolean|Array|Object | undefined | The field's external model value; used only in contextless mode (v-model binding). | |
| contextless | Boolean | false | When true, the field ignores any surrounding form context and manages its own state. | |
| themeOverride | String|Object|Array | null | A partial theme object merged with the component's default theme; accepts a class string, class array, or theme object. | |
| type | string | "number" | The data type of the range boundaries (e.g. "number" or "date"). | |
| suffixes | array | ["lower", "upper"] | A two-element array of suffixes appended to the field name to produce the lower and upper boundary field names; must be provided in lower, upper order. |
Slots
| Name | Scoped | Description |
|---|---|---|
separator | Replaces the glyph rendered between the lower and upper sub-fields. | |
field-set-level-chores | Override the validation block rendered below the range sub-fields. |
Events
| Name | Description |
|---|---|
update:modelValue | Emitted when the field value changes. |
Source
client/lib/form/field-set/FieldSetRange.vue