Switch
Switch edits an immediately visible on/off state. It participates in the state, validation, and submission boundary of its Form.
1. When to use it
Typical uses:
- Feature enablement
- Boolean permissions or preferences
- Settings that can change without extra confirmation
2. Add and configure
- Add Switch to the Fields slot of a Form Section.
- Set a stable, unique Field Key / Name that matches the backend DTO property.
- Configure the component properties below, then add Required, Help Text, Full row, or conditions as needed.
- Check the initial value and layout in Design Preview, then use Form Validate / Submit to test the full data path.
3. Main properties
| Property | Purpose |
|---|---|
| Checked By Default | Sets the initial value, content, or format used by the field. |
| Checked Content / Unchecked Content | Controls how the field is displayed in Design Preview and Runtime. |
| Switch Size | Controls how the field is displayed in Design Preview and Runtime. |
| Disabled | Enables or disables this behavior. |
| Required | Enables or disables this behavior. |
Common properties such as Field Key, Required, Help Text, Full row, and Visible When come from the Form field contract. The table highlights the settings most relevant to Switch.
4. Form value and backend contract
Submitted value: A Boolean: true or false.
true
The example shows the data shape only. The API must still validate type, range, and authorization against its business DTO.
5. Validation, conditions, and interactions
Every field can use Form properties such as Required, Visible When, Disabled When, Required When, Dependencies, and Clear When Hidden. Conditions improve interaction but never replace backend validation or authorization.
Component capabilities: Supports onChange so a selection change can continue a Page Interaction.
6. Recommendations
Recommendations: Keep option values stable for backend enums or IDs. Labels may be localized, but must not be used as business keys.
Return to the Form overview for layout, validation, submission, drafts, and backend protocol guidance.