The Date Range component for Retool Apps
An input field to select or enter a date range.
Settings
Date Range includes the following configurable options when building apps in the IDE.
Date Range can display values using different time zones and adjust for the time difference. For example, January 1, 2021 at 11:00 PM (UTC) can be displayed as January 2, 2021 at 8:00 AM (UTC+9:00).
Properties
All properties for Date Range with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
customValidation
The custom validation message to display if the invalid is true.
dateFormat
The displayed date format.
endPlaceholder
The text to display in the input field when the end date is empty.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
Values
datasource | Control query. |
widget | Control component. |
script | Run script. |
state | Set variable. |
localStorage | Set localStorage. |
util | Perform utility action (e.g., Open URL or Confetti). |
formattedValue
The selected value in the specified format.
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.
global
Whether the object is globally scoped for use in all app pages.
Whether to hide the validation message if the invalid is true.
Values
You can select an icon or dynamically set one with a valid icon key.
iconBefore
The prefix icon to display.
Values
You can select an icon or dynamically set one with a valid icon key.
id
The unique identifier.
invalid
Whether the value has failed any validation rules.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The label for the node.
labelPosition
The position of the label relative to the input field or value.
Values
top | Above the input field or value. |
left | Left of the input field or value. |
labelWidth
The label width, in the unit specified in labelWidthUnit.
labelWidthUnit
The specified units for labelWidth, if labelPosition is left.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden is true.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden is true.
startPlaceholder
The text to display in the input field when the start date is empty.
textBefore
The prefix text to display.
textBetween
The text to display between selected dates.
tooltipText
The tooltip text to display.
validationMessage
The validation message to display if invalid is true.
Methods
JavaScript API methods for interacting with Date Range. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValidation
Clear the validation message from the input field.
dateRange.clearValidation()
clearValue
Clear the current values.
dateRange.clearValue()
focus
Set focus on the input field.
dateRange.focus()
resetValue
Reset the current value to the default value.
dateRange.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
dateRange.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
The scroll position relative to the component.
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. |
setDisabled
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
setHidden
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
dateRange.setHidden(hidden)
Parameters
setRange
Set the end range value.
setStartRange
Set the start range value.
setValue
Set the current value.
validate
Validates the value of the input field.
dateRange.validate()
Events
Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.
blur
The input field is blurred.
change
The value is changed.
focus
The input field is focused.
submit
Input values are submitted.