The Range Slider component for Retool Apps
An input field to select a range of number values.
For more information about using the Range Slider component, refer to the number inputs guide.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
customValidation
A custom validation rule using {{ }}
expression with conditional logic. An invalid match evaluates to a string which is used as the validation message. An empty or nullish value is considered valid.
Type | string |
Format | Plain Text |
Configurability | Inspector > Interaction > Validation rules > Custom rule |
Default | null |
Examples
"{{ value.length > 5 ? 'Value must be longer than 5 characters' : '' }}"
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Disabled |
Default | false |
Examples
true
events
A list of configured event handlers that trigger actions or queries.
Type | array |
Array values | object |
Configurability | Inspector > Interaction > Event handlers |
Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
Type | string |
Configurability | Inspector > Interaction > Event handlers > Event |
Default | null |
method
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
Type | string |
Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
Default | null |
type
The type of action to perform.
Type | string | ||||||||||||||
Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
Allowed Values |
| ||||||||||||||
Default | null |
formDataKey
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
Type | string |
Format | Plain Text |
Configurability | Inspector > Interaction > Form data key |
Default | {{ self.id }} |
Examples
table1.selectedRow.id
hideOutput
Whether to hide the caption displayed with the value.
Type | boolean |
Configurability | Inspector |
Default | null |
hideValidationMessage
Whether to hide the validation message if the invalid
is true
.
Type | boolean |
Configurability | Inspector > Appearance > Advanced > Hide validation message |
Default | null |
iconAfter
The suffix icon to display.
Type | string |
Format | Icon Key |
Configurability | Inspector > Content > Add-ons > Suffix icon |
Default | null |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
Type | string |
Format | Icon Key |
Configurability | Inspector > Content > Add-ons > Prefix icon |
Default | null |
Examples
/icon:bold/shopping-gift
id
The unique identifier (name).
Type | string |
Format | Plain Text |
Configurability | Inspector |
Default | rangeSlider1 |
Examples
query1
button1
invalid
Whether the value has failed any validation rules.
Type | boolean |
Configurability | Read-only |
Default | null |
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Advanced > Show on desktop |
Default | false |
Examples
true
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Advanced > Show on mobile |
Default | true |
Examples
true
labelPosition
The position of the label relative to the input field or value.
Type | string | |||||||||
Format | Plain Text | |||||||||
Configurability | Inspector > Content > Add-ons > Label > Position | |||||||||
Allowed Values |
| |||||||||
Default | left |
Examples
top
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
Default | false |
Examples
true
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Configurability | Inspector > Spacing > Margin | |||||||||
Allowed Values |
| |||||||||
Default | 4px 8px |
Examples
4px 8px
max
The maximum value to allow.
Type | number |
Configurability | Inspector > Interaction > Validation rules > Maximum |
Default | null |
min
The minimum value to allow.
Type | number |
Configurability | Inspector > Interaction > Validation rules > Minimum |
Default | null |
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean |
Format | True/False |
Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
Default | false |
Examples
true
tooltipText
The tooltip text to display next to the label on hover.
Type | string |
Format | Markdown |
Configurability | Inspector > Content > Add-ons > Helper text |
Default | null |
Examples
Submit
validationMessage
The validation message to display if invalid
is true
.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Object Properties
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
rangeSlider.clearValidation()
Clear the validation message from the input field.
rangeSlider.clearValidation()
Examples
Clear the validation message from rangeSlider
.
rangeSlider.clearValidation();
rangeSlider.clearValue()
Clear the current values.
rangeSlider.clearValue()
Examples
Clear the current value of rangeSlider
.
rangeSlider.clearValue();
rangeSlider.focus()
Set focus on the input field.
rangeSlider.focus()
Examples
Set focus on rangeSlider
.
rangeSlider.focus();
rangeSlider.resetValue()
Reset the current value to the default value.
rangeSlider.resetValue()
Examples
Reset the current value of rangeSlider
.
rangeSlider.resetValue();
rangeSlider.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
rangeSlider.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring rangeSlider
into view.
rangeSlider.scrollIntoView({behavior: 'auto', block: 'nearest'});
rangeSlider.setDisabled()
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
rangeSlider.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Default |
|
Examples
true
Examples
Disable rangeSlider
.
rangeSlider.setDisabled(true);
Enable rangeSlider
.
rangeSlider.setDisabled(false);
rangeSlider.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
rangeSlider.setHidden(hidden)
Parameters
Examples
true
Examples
Hide rangeSlider
.
rangeSlider.setHidden(true);
Unhide rangeSlider
.
rangeSlider.setHidden(false);
rangeSlider.setValue()
Set the current value.
rangeSlider.setValue(key, value)
Examples
Set the current value of rangeSlider
to userValue
.
rangeSlider.setValue(userValue);
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
Event | Description |
---|---|
Change | The value is changed. |