Skip to main content

Radio


The Radio element presents a single-select option within a defined group. Each radio instance supports label text, validation, and events. Use this component for user preferences, settings, and form-driven workflows where the user must choose exactly one item.

Radio button preview with label

Properties

PropertyValueDescription
TypeRadioUI component type
GroupFieldBelongs to the "Field" group in the UI catalog
Identifier39Unique element ID
PreviewDisplays preview image
ValueYStores selected option
MandatoryYRequires a selection when validation is active
ErrorYDisplays validation error messages
MinNot applicable
MaxNot applicable
Read-onlyYDisplays without allowing user interaction
Text, IconYSupports label text and inline icons
EventYTriggers changes on selection
ShadeYUses background shading when styled
ChildrenDoes not support nested components
ListNot a list container

Usage Example

<RadioGroup name="language">
<Radio value="en" label="English" />
<Radio value="he" label="Hebrew" />
<Radio value="es" label="Spanish" />
</RadioGroup>

SDK Integration

The Language Selection screen includes this element. It links to the SDK method:

Method: /account/language-change

Changes the app’s display language. Applies internationalization across all screens and appointment workflows.


Example UI Placement

LevelIDTypeValueDescription
1enRadioEnglishDefault English option
1language~heRadioHebrewSelects Hebrew
1language~esRadioSpanishSelects Spanish
1language~frRadioFrenchSelects French

Notes

  • Place radio buttons within a RadioGroup to enforce single-selection behavior.
  • Use when choices are mutually exclusive.
  • Always provide meaningful, descriptive labels.