Skip to main content

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
LabelText shown above the slider, or beside it when Layout is horizontal.Text. Default: Volume
ExtraHelp text shown under the field. A validation message replaces it while the value is not valid.Text
TooltipText shown from an info icon after the label.Text
LayoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.vertical, horizontal. Default: vertical
ValueThe 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
RangeShows two handles so the user picks a range. Value is then a [from, to] pair.On or off. Default: Off
MinLowest number on the slider.Number. Default: 0
MaxHighest number on the slider.Number. Default: 100
StepAmount the value changes by between stops.Number. Default: 1
DotsShows 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
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets 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 desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows 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 changeTriggers while the value changes, including at each step while the user drags.
On change completeTriggers 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 valueSets the slider to the given Value, a number or a [from, to] pair with Range on.components.slider1.setFieldValue("")
Reset fieldSets the slider back to the Value property.components.slider1.resetFields()
Set visibilityShows the component when true, hides it when false.components.slider1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.slider1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.slider1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the slider, or beside it when Layout is horizontal.{{components.slider1.label}}
extraHelp text shown under the field. A validation message replaces it while the value is not valid.{{components.slider1.extra}}
tooltipText shown from an info icon after the label.{{components.slider1.tooltip}}
layoutWhere the label sits: vertical puts it above the field, horizontal puts it to the left.{{components.slider1.layout}}
valueThe 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}}
rangeShows two handles so the user picks a range. Value is then a [from, to] pair.{{components.slider1.range}}
minLowest number on the slider.{{components.slider1.min}}
maxHighest number on the slider.{{components.slider1.max}}
stepAmount the value changes by between stops.{{components.slider1.step}}
dotsShows a dot at each step on the track.{{components.slider1.dots}}
isVisibleWhether the component is visible.{{components.slider1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.slider1.isLoading}}
isDisabledWhether the component is disabled.{{components.slider1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 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.