The Date Range component for Retool Apps
An input field to select or enter a date range.
For more information about using the Date Range component, refer to the dates and times 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.
endPlaceholder
The text to display in the input field when the end date is empty.
| Type | string | ||||
| Mutability |
|
hidden
Whether this object is hidden from view.
| Type | boolean | ||||||
| Format | True/False | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
id
The unique identifier (name).
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
| ||||
| Default | |
Examples
query1
button1
startPlaceholder
The text to display in the input field when the start date is empty.
| Type | string | ||||
| Mutability |
|
textBetween
The text to display between selected dates.
| Type | string | ||||
| Mutability |
|
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
dateRange.clearValidation()
Examples
Clear the validation message from dateRange.
dateRange.clearValidation();
dateRange.clearValue()
Examples
Clear the current value of dateRange.
dateRange.clearValue();
dateRange.focus()
Examples
Set focus on dateRange.
dateRange.focus();
dateRange.resetValue()
Examples
Reset the current value of dateRange.
dateRange.resetValue();
dateRange.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
dateRange.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 dateRange into view.
dateRange.scrollIntoView({behavior: 'auto', block: 'nearest'});
dateRange.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
dateRange.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Examples
Disable dateRange.
dateRange.setDisabled(true);
Enable dateRange.
dateRange.setDisabled(false);
dateRange.setEndRange(end)
Parameters
end
The end value.
dateRange.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
dateRange.setHidden(hidden)
Parameters
hidden
Whether this object is hidden from view.
Examples
Hide dateRange.
dateRange.setHidden(true);
Unhide dateRange.
dateRange.setHidden(false);
dateRange.setRange(options)
Parameters
options
Object Properties
end
The end value.
start
The start value.
dateRange.setStartRange(start)
Parameters
start
The start value.
dateRange.setValue(value)
Parameters
value
The value.
Examples
Set the current value of dateRange to userValue.
dateRange.setValue(userValue);
dateRange.validate()
Examples
Validate the value of dateRange.
dateRange.validate();
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.