The Slider component for Retool Apps
A slider to select a number value.
For more information about using the 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 | ||||
| Mutability |
|
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 | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
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 | ||||
| Mutability |
| ||||
| Default | |
Examples
table1.selectedRow.id
hideOutput
Whether to hide the caption displayed with the value.
| Type | boolean | ||||
| Mutability |
|
hideValidationMessage
Whether to hide the validation message if the invalid is true.
| Type | boolean | ||||
| Mutability |
|
iconAfter
The suffix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
iconBefore
The prefix icon to display.
| Type | string | ||||
| Format | Icon Key | ||||
| Mutability |
| ||||
| Default | |
Examples
/icon:bold/shopping-gift
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
Examples
top
max
The maximum value to allow.
| Type | number | ||||
| Mutability |
|
min
The minimum value to allow.
| Type | number | ||||
| Mutability |
|
step
The step value to increment or decrement by.
| Type | number | ||||
| Mutability |
|
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
validationMessage
The validation message to display if invalid is true.
| Type | string |
| Format | Plain Text |
| Mutability | Read-only |
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
slider.clearValidation()
Examples
Clear the validation message from slider.
slider.clearValidation();
slider.clearValue()
Examples
Clear the current value of slider.
slider.clearValue();
slider.focus()
Examples
Set focus on slider.
slider.focus();
slider.resetValue()
Examples
Reset the current value of slider.
slider.resetValue();
slider.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
slider.scrollIntoView(options)
Parameters
options Required
The scroll options.
Object Properties
behavior Required
The scroll behavior.
Supported Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block Required
The scroll position relative to the component.
Supported Values
nearest | Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. |
start | Scrolls to position the component at the top of the visible area. |
center | Scrolls to position the component in the middle of the visible area. |
end | Scrolls to position the component at the bottom of the visible area. |
Examples
Scroll the minimum amount to immediately bring slider into view.
slider.scrollIntoView({behavior: 'auto', block: 'nearest'});
slider.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
slider.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Examples
Disable slider.
slider.setDisabled(true);
Enable slider.
slider.setDisabled(false);
slider.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
slider.setHidden(hidden)
Parameters
hidden
Whether this object is hidden from view.
Examples
Hide slider.
slider.setHidden(true);
Unhide slider.
slider.setHidden(false);
slider.setValue(value)
Parameters
value
The value.
Examples
Set the current value of slider to userValue.
slider.setValue(userValue);
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.