The Slider component for Retool Mobile
A slider to select a number value.
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.
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Disabled |
| Default | false |
Examples
falsetrue
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 |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
label
The text label to display.
| Type | string |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Label |
| Default | null |
Examples
false"Label"
labelCaption
Whether to hide the caption displayed with the value.
| Type | boolean |
| Format | Plain Text |
| Configurability | Inspector > Content > Add-ons > Label > Hide output |
| Default | null |
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 |
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.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.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
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
Examples
true
Examples
Hide slider.
slider.setHidden(true);
Unhide slider.
slider.setHidden(false);
slider.setValue(value)
Examples
Set the current value of slider to userValue.
slider.setValue(userValue);
slider.validate()
Examples
Validate the value of slider.
slider.validate();
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. |