ToolJet/docs/versioned_docs/version-2.43.0/widgets/date-range-picker.md
Aman Regu 3c9b04c8cd
[docs]: Add docs for v2.43.0 (#9768)
* add: docs for v2.43.0

* fix: broken links

* update: database editor based on feedback

* update: next

* update: querying tjdb with fk

* move available-actions below  create fk

* update: foreign key actions
2024-05-17 21:54:13 +05:30

4.3 KiB

id title
date-range-picker Date-range Picker

Date-Range Picker

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

Properties

<div style={{ width:"135px"}}> Property <div style={{ width:"100px"}}> Description
Default start date Set the start date to be selected by default in the widget
Default end date Set the start date to be selected by default in the widget
Format The 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.

Events

Date range picker supports the following events:

<div style={{ width:"100px"}}> Event <div style={{ width:"100px"}}> Description
On select The 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. :::

Component Specific Actions (CSA)

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

Exposed Variables

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

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 General accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.

Layout

<div style={{ width:"100px"}}> Layout <div style={{ width:"100px"}}> Description <div style={{ width:"135px"}}> Expected Value
Show on desktop Toggle 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 mobile Toggle on or off to display mobile view. You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}

Styles

<div style={{ width:"100px"}}> Style <div style={{ width:"100px"}}> Description <div style={{ width:"135px"}}> Default Value
Border radius This is to modify the border radius of the date range picker. The field expects only numerical value from 1 to 100 By default, it's set to 0
Visibility This 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}}
Disable This 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. :::