Back to Tooljet

Date-range Picker

docs/versioned_docs/version-2.61.0/widgets/date-range-picker.md

3.20.154-lts4.3 KB
Original Source

Date-Range Picker

The Date-Range Picker widget allows users to select a range of dates.

<div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Properties

<div style={{ width:"135px"}}> Property </div><div style={{ width:"100px"}}> Description </div>
Default start dateSet the start date to be selected by default in the widget
Default end dateSet the start date to be selected by default in the widget
FormatThe format of the date selected by the date picker. Default date format is DD/MM/YYYY. Date format should be followed as ISO 8601 as mentioned in the moment documentation.
</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Events

Date range picker supports the following events:

<div style={{ width:"100px"}}> Event </div><div style={{ width:"100px"}}> Description </div>
On selectThe On select event is triggered when the a start date and end date is selected on the picker. Just like any other event on ToolJet, you can set multiple handlers for on select event.

:::info Check Action Reference docs to get the detailed information about all the Actions. :::

</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Component Specific Actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the component.

</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Exposed Variables

<div style={{ width:"100px"}}> Variables </div><div style={{ width:"135px"}}> Description </div><div style={{ width:"135px"}}> How To Access </div>
endDateThis variable holds the date of the endDate selected in the component.Access the value dynamically using JS: {{components.customcomponent1.data.title}}
startDateThis variable holds the value assigned inside the code for custom component.Access the value dynamically using JS: {{components.customcomponent1.data.title}}
</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.

Under the <b>General</b> accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.

</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Layout

<div style={{ width:"100px"}}> Layout </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
Show on desktopToggle on or off to display desktop view.You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}
Show on mobileToggle on or off to display mobile view.You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}
</div> <div style={{paddingTop:'24px', paddingBottom:'24px'}}>

Styles

<div style={{ width:"100px"}}> Style </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Default Value </div>
Border radiusThis is to modify the border radius of the date range picker. The field expects only numerical value from 1 to 100By default, it's set to 0
VisibilityThis is to control the visibility of the widget. If {{false}} the widget will not visible after the app is deployed. It can only have boolean values i.e. either {{true}} or {{false}}.By default, it's set to {{true}}
DisableThis property only accepts boolean values. If set to {{true}}, the widget will be locked and becomes non-functional.By default, its value is set to {{false}}

:::info Any property having Fx button next to its field can be programmatically configured. :::

</div>