ToolJet/docs/versioned_docs/version-2.50.0-LTS/widgets/date-range-picker.md
Rudraksh Gajanan Nalbalwar 446adc0465
[docs]: Fix documentation for the Date-Range Picker Component (#11020)
* updated ToolJet/docs/docs/widgets/date-range-picker.md

* updated  ToolJet/docs/versioned_docs/version-2.50.0-LTS/widgets/date-range-picker.md

* removed paddingbottom and renaming widget

* Update date-range-picker.md

* Update date-range-picker.md

* Update date-range-picker.md

* Update date-range-picker.md

* Update date-range-picker.md

* Update date-range-picker.md

---------

Co-authored-by: Pratik Agrawal <pratik@tooljet.com>
2024-10-30 14:54:33 +05:30

4 KiB

id title
date-range-picker Date-range Picker

The Date-Range Picker component 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 component.
Default end date Set the start date to be selected by default in the component.
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

<div style={{ width:"100px"}}> Event <div style={{ width:"100px"}}> Description
On select Triggered when a start date and end date are selected.

:::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 the 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 component.

Under the General accordion, you can set the value in the string format. Now hovering over the component 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 component. If {{false}} the component 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 component 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. :::