The Date Picker mobile component
An input field to select or enter a date.
Settings
Date Picker includes the following configurable options when building apps in the IDE.
Properties
All properties for Date Picker 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
.
displayTimeZone
The time zone (UTC offset) that applies to the display value. Uses the time zone reported by the browser if set to local
.
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
.
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.
Whether to hide the validation message if the invalid
is true
.
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.
labelCaption
The additional text to display with the label.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
manageTimeZone
Whether to adjust the value and display value of time zones using valueTimeZone
and displayTimeZone
respectively.
Values
date | Select dates only. |
dateTime | Select dates and times. |
placeholder
The text to display within the input field when there is no value.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
validationMessage
The validation message to display if invalid
is true
.
valueTimeZone
The time zone (UTC offset) to encode in value
. Select local
to use the time zone reported by the user's browser.
Methods
JavaScript API methods for interacting with Date Picker. 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.
datePicker.clearValidation()
clearValue
Clear the current values.
datePicker.clearValue()
focus
Set focus on the input field.
datePicker.focus()
resetValue
Reset the current value to the default value.
datePicker.resetValue()
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.
datePicker.setHidden(hidden)
Parameters
validate
Validates the value of the input field.
datePicker.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.
change
The value is changed.