Slider
Ant Design
The Slider component is Ant Design's slider. Users drag a handle to pick a number in a range, or two handles to pick a range, such as a price band or a discount.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the slider, or beside it when Layout is horizontal. | Text. Default: Volume |
| 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 |
| Value | The starting number, or a [from, to] pair such as [20, 80] when Range is on. It's kept between Min and Max and on a Step. | Number. Default: 0 |
| Range | Shows two handles so the user picks a range. Value is then a [from, to] pair. | On or off. Default: Off |
| Min | Lowest number on the slider. | Number. Default: 0 |
| Max | Highest number on the slider. | Number. Default: 100 |
| Step | Amount the value changes by between stops. | Number. Default: 1 |
| Dots | Shows a dot at each step on the track. | On or off. Default: Off |
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 while the value changes, including at each step while the user drags. |
| On change complete | Triggers when the user releases the handle. |
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 | Sets the slider to the given Value, a number or a [from, to] pair with Range on. | components.slider1.setFieldValue("") |
| Reset field | Sets the slider back to the Value property. | components.slider1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.slider1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.slider1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.slider1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the slider, or beside it when Layout is horizontal. | {{components.slider1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.slider1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.slider1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.slider1.layout}} |
value | The starting number, or a [from, to] pair such as [20, 80] when Range is on. It's kept between Min and Max and on a Step. | {{components.slider1.value}} |
range | Shows two handles so the user picks a range. Value is then a [from, to] pair. | {{components.slider1.range}} |
min | Lowest number on the slider. | {{components.slider1.min}} |
max | Highest number on the slider. | {{components.slider1.max}} |
step | Amount the value changes by between stops. | {{components.slider1.step}} |
dots | Shows a dot at each step on the track. | {{components.slider1.dots}} |
isVisible | Whether the component is visible. | {{components.slider1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.slider1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.slider1.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.