RadioButton
RadioButton widget renders a simple Radio button, which can be grouped with other RadioButtons anywhere on the screen with the groupId.
Test in Kitchen Sink (opens in a new tab)
Properties
| Property | Type | Description |
|---|---|---|
| value | any | The value of this Radio Button. This value should be unique among other RadioButtons with the same groupId. |
| groupId | string | The groupId that group a collection of RadioButtons. This is a required field |
| selected | boolean | Whether this RadioButton should be selected by default |
This widget also inherit the following Form Field properties:
| Property | Type | Description |
|---|---|---|
| label | string | Label for your widget |
| labelHint | string | Hint text on your label |
| required | boolean | Whether the field is required |
| enabled | boolean | Whether the field is enabled |
| icon | Icon | Include an icon on this form field |
Styles
| Property | Type | Description |
|---|---|---|
| activeColor | Color | Color when a radio button is selected |
| inactiveColor | Color | Color when a radio button is not selected |
This widget also inherits these base styles:
| Property | Type | Description |
|---|---|---|
| visible | boolean | Toggle a widget visibility on/off. Note that an invisible widget will not occupy UI space, unless the visibilityTransitionDuration is specified. |
| visibilityTransitionDuration | number | Specify the duration in seconds when a widget animates between visible and not visible state. Note that setting this value will cause the widget to still occupy the UI space even when it is not visible. |
| elevation | integer | The z-coordinate at which to place this material relative to its parent. A non-zero value will show a shadow, with its size relative to the elevation value. (Minimum: 0, Maximum: 24) |
| elevationShadowColor | Color | The shadow color for the elevation. |
| elevationBorderRadius | integer / string | If the widget has a borderRadius, this should be changed to have the same value. Use with CSS-like notation (1 to 4 integers). |
| alignment | Alignment | Align this widget relative to its parent. |
| stackPositionTop | integer | The distance of the child's top edge from the top of the stack. This is applicable only for Stack's children. |
| stackPositionBottom | integer | The distance that the child's bottom edge from the bottom of the stack. This is applicable only for Stack's children. |
| stackPositionLeft | integer | The distance that the child's left edge from the left of the stack. This is applicable only for Stack's children. |
| stackPositionRight | integer | The distance that the child's right edge from the right of the stack. This is applicable only for Stack's children. |
| captureWebPointer | boolean | Applicable for Web only. When overlaying widgets on top of certain HTML container (e.g., Maps), the mouse click is captured by the HTML container, causing issue interacting with the widget. Use this to capture and maintain the mouse pointer on your widget. |