The Calendar Input component for Retool Apps
An input field to select a specific date on a calendar.
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 | ||||||
| Mutability |
| ||||||
| Default | |
Examples
true
firstDayOfWeek
The first day of the week, by index, with Sunday as 0.
| Type | string | ||||||||||||||||
| Mutability |
| ||||||||||||||||
| Allowed Values |
|
labelPosition
The position of the label relative to the input field or value.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
Examples
top
readOnly
Whether user input is read-only.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
required
Whether a value is required to be selected.
| Type | boolean | ||||
| Format | True/False | ||||
| Mutability |
| ||||
| Default | |
Examples
true
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
calendarInput.clearValue()
Clear the current values.
calendarInput.clearValue()
Examples
Clear the current value of calendarInput.
calendarInput.clearValue();
calendarInput.focus()
Set focus on the input field.
calendarInput.focus()
Examples
Set focus on calendarInput.
calendarInput.focus();
calendarInput.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
calendarInput.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 calendarInput into view.
calendarInput.scrollIntoView({behavior: 'auto', block: 'nearest'});
calendarInput.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
calendarInput.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Examples
Disable calendarInput.
calendarInput.setDisabled(true);
Enable calendarInput.
calendarInput.setDisabled(false);
calendarInput.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
calendarInput.setHidden(hidden)
Parameters
hidden
Whether this object is hidden from view.
Examples
Hide calendarInput.
calendarInput.setHidden(true);
Unhide calendarInput.
calendarInput.setHidden(false);
calendarInput.setValue()
Set the current value.
calendarInput.setValue(value)
Parameters
value
The value.
Examples
Set the current value of calendarInput to userValue.
calendarInput.setValue(userValue);
Events
Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.
s