Segmented
Ant Design
The Segmented component is Ant Design's segmented control. It shows a few options as one joined bar for switching between views, such as daily, weekly and monthly.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the field, or beside it when Layout is horizontal. | Text. Default: View |
| Extra | Help text shown under the field. A validation message replaces it while the value is not valid. | Text |
| Tooltip | Text shown from an info icon after the label. | Text |
| Layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | vertical, horizontal. Default: vertical |
| Options | The choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Daily', value: 'daily' }]. | Array |
| Value | Value of the option picked at the start. Leave it empty to start with no option picked. | Text |
| Block | Stretches the bar to the full width of the component, with equal-width options. | On or off. Default: Off |
| Alignment | Where the bar sits in the component's box when Block is off. | Left, Center, Right. Default: Left |
| Vertical | Stacks the options in a column instead of a row. | On or off. Default: Off |
| Size | Height and text size of the options. | small, middle, large. Default: middle |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets the component grow with its content in the running app instead of keeping a fixed height. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows the component in the mobile layout. | On or off. Default: Off |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On change | Triggers when the picked option changes. |
Component Specific Actions (CSA)​
Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.
Action | Description | How To Access |
|---|---|---|
| Set field value | Picks the option with the given Value. | components.segmented1.setFieldValue("") |
| Reset field | Sets the choice back to the Value property. | components.segmented1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.segmented1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.segmented1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.segmented1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the field, or beside it when Layout is horizontal. | {{components.segmented1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.segmented1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.segmented1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.segmented1.layout}} |
options | The choices, as plain values or as { label, value, disabled } objects, such as [{ label: 'Daily', value: 'daily' }]. | {{components.segmented1.options}} |
value | Value of the option picked at the start. Leave it empty to start with no option picked. | {{components.segmented1.value}} |
block | Stretches the bar to the full width of the component, with equal-width options. | {{components.segmented1.block}} |
alignment | Where the bar sits in the component's box when Block is off. | {{components.segmented1.alignment}} |
vertical | Stacks the options in a column instead of a row. | {{components.segmented1.vertical}} |
size | Height and text size of the options. | {{components.segmented1.size}} |
isVisible | Whether the component is visible. | {{components.segmented1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.segmented1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.segmented1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 0px 0px 0px #00000040 |
A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.