The Date Picker component for Retool Mobile

An input field to select or enter a date.

Version: Self-hosted 3.114 Stable

Demo

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	Control Usage Retool UI Inspector > Interaction Method setDisabled()
Default	false

Examples

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.

Type	string
Mutability	Control Usage Retool UI Inspector

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance Method setHidden()
Default	false

Examples

true

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
Default	null

Examples

"Label"

---

labelCaption

The additional text to display with the label.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label

---

manageTimeZone

Whether to adjust the value and display value of time zones using valueTimeZone and displayTimeZone respectively.

Type	unknown
Mutability	Control Usage Retool UI Inspector

---

mode

How to render images to fit.

Type	string
Mutability	Control Usage Retool UI Inspector Method setMode()
Allowed Values	Value Description cover Scale the image to fit the area while preserving the aspect ratio. center Center the image. stretch Resize the image to the same dimensions as the area. contain Scale and clip the image to fit the area while preserving the aspect ratio.

---

placeholder

The text to display within the input field when there is no value.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content
Default	Enter a value

Examples

Enter a value

---

timeZoneValue

The time zone (UTC offset) to encode in value. Select local to use the time zone reported by the user's browser.

Type	unknown
Mutability	Control Usage Retool UI Inspector

---

value

The current or default value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content Method setValue()
Default	null

Examples

Hello world!

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

datePicker.clearValidation()

Clear the validation message from the input field.

Definition

datePicker.clearValidation()

Examples

Clear the validation message from datePicker.

datePicker.clearValidation();

---

datePicker.clearValue()

Clear the current values.

Definition

datePicker.clearValue()

Examples

Clear the current value of datePicker.

datePicker.clearValue();

---

datePicker.focus()

Set focus on the input field.

Definition

datePicker.focus()

Examples

Set focus on datePicker.

datePicker.focus();

---

datePicker.resetValue()

Reset the current value to the default value.

Definition

datePicker.resetValue()

Examples

Reset the current value of datePicker.

datePicker.resetValue();

---

datePicker.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

datePicker.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

Examples

Disable datePicker.

datePicker.setDisabled(true);

Enable datePicker.

datePicker.setDisabled(false);

---

datePicker.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

datePicker.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide datePicker.

datePicker.setHidden(true);

Unhide datePicker.

datePicker.setHidden(false);

---

datePicker.setValue()

Sets the value of the date picker.

Definition

datePicker.setValue(value)

Parameters

value

string | number | boolean | object | array

The value.

Examples

Set the current value of datePicker to userValue.

datePicker.setValue(userValue);

---

datePicker.validate()

Validates the value of the input field.

Definition

datePicker.validate()

Examples

Validate the value of datePicker.

datePicker.validate();

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---