Date Range
A combination select and input field to select two dates from a popup or directly enter them as text. It supports start and end values, and minimum and maximum dates.
Date Range can display values using different time zones and adjust for the time difference. For example, a value of January 1, 2021 at 11:00 PM (UTC) can be displayed as January 2, 2021 at 8:00 AM (UTC+9:00).
Properties
Available properties for Date Range with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
The current value.
The displayed date format.
Whether user input, interaction, or selection is disabled.
The text to display in the input field when the end date is empty.
The key used by a Form component to assign default values to input fields using form.initialData
, and to construct the form.data
property.
The selected value in the specified format.
Whether the component is visible.
Whether to hide the validation message if the invalid
is true
.
The icon to display after the primary content.
The icon to display before the primary content.
Whether the current value has failed any validation rules.
The text to display as a label for the input field.
The horizontal alignment of the label.
The additional text to display with the label.
The position of the label relative to the input field.
The label width, in the unit specified in labelWidthUnit
.
The specified units for labelWidth
.
Whether the label can wrap to multiple lines.
Whether to display a loading indicator.
Whether the component takes up space on the canvas if hidden
is true
.
The amount of margin to render outside of the component.
The latest date to allow.
The earliest date to allow.
Whether the value is read only and cannot be modified.
Whether the input is required for validation.
Whether to display a button to clear the current value of the input field.
Whether the component remains visible in the editor if hidden
is true
.
The text to display in the input field if the start date is empty.
The text to display after the primary content.
The text to display before the primary content.
The text to display between the two input fields.
The text to display in a tooltip on hover or focus.
The validation message to display if the input is invalid.
Events
Events are triggered by user interactions with Date Range. Use event handling to trigger queries or other actions in response to events.
A user submits the current value.
A user changes the current value.
A user selects the input field.
A user deselects the input field.
Methods
Methods for interacting with Date Range. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.
Set the current date range values.
Clear the current value.
Scrolls the canvas or parent container so that the selected component appears in the visible area.
Validates the value of the input field.
Clear the validation message from the input field.
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
Reset to the default value.
Set focus on the input field.
Removes focus on the input field.
Specify a start value of the date range
Specify an end value of the date range
Set the current date range values.