The Date Range component for Retool Apps

An input field to select or enter a date range.

Version: Cloud and 3.234 Edge

Demo

For more information about using the Date Range component, refer to the dates and times guide.

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.

dateFormat

The displayed date format.

Type	string
Configurability	Inspector

---

endPlaceholder

The text to display in the input field when the end date is empty.

Type	string
Configurability	Inspector

---

events

A list of configured event handlers that trigger actions or queries.

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event

---

method

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	dateRange1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

maxDate

The latest date to allow.

Type	string
Configurability	Inspector

---

minDate

The earliest date to allow.

Type	string
Configurability	Inspector

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

startPlaceholder

The text to display in the input field when the start date is empty.

Type	string
Configurability	Inspector

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style

---

textBetween

The text to display between selected dates.

Type	string
Configurability	Inspector

---

value

The value.

Type	array
Array values	string
Configurability	Read-only

---

Methods

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

dateRange.clearValidation()

Clear the validation message from the input field.

Definition

dateRange.clearValidation()

Examples

Clear the validation message from dateRange.

dateRange.clearValidation();

---

dateRange.clearValue()

Clear the current values.

Definition

dateRange.clearValue()

Examples

Clear the current value of dateRange.

dateRange.clearValue();

---

dateRange.focus()

Set focus on the input field.

Definition

dateRange.focus()

Examples

Set focus on dateRange.

dateRange.focus();

---

dateRange.resetValue()

Reset the current value to the default value.

Definition

dateRange.resetValue()

Examples

Reset the current value of dateRange.

dateRange.resetValue();

---

dateRange.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

dateRange.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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 dateRange into view.

dateRange.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

dateRange.setDisabled()

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

Definition

dateRange.setDisabled(disabled)

Parameters

disabled

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Disable dateRange.

dateRange.setDisabled(true);

Enable dateRange.

dateRange.setDisabled(false);

---

dateRange.setEndRange()

Set the end range value.

Definition

dateRange.setEndRange(end)

Parameters

end

The end value.

Type

number

---

---

dateRange.setHidden()

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

Definition

dateRange.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide dateRange.

dateRange.setHidden(true);

Unhide dateRange.

dateRange.setHidden(false);

---

dateRange.setRange()

Set the end range value.

Definition

dateRange.setRange(options)

Parameters

options

(No description available)

Type

object

Object Properties

end

The end value.

Type

number

---

start

The start value.

Type

number

---

---

---

dateRange.setStartRange()

Set the start range value.

Definition

dateRange.setStartRange(start)

Parameters

start

The start value.

Type

number

---

---

dateRange.setValue()

Set the current value.

Definition

dateRange.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of dateRange to userValue.

dateRange.setValue(userValue);

---

dateRange.validate()

Validates the value of the input field.

Definition

dateRange.validate()

Examples

Validate the value of dateRange.

dateRange.validate();

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Blur	The input field is deselected.
Change	The value is changed.
Focus	The input field is selected.
Submit	The value is submitted.