studio/cunningham
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝(react) add a timezone management section to date picker docs

Browse Source 
Describe the current behavior of date picker components,
especially with the recent changes in component's API.
This commit is contained in:
Lebaud Antoine
2023-07-24 22:24:48 +02:00
committed by aleb_the_flash
parent 9d31c502b8
commit 7e5a11ec7d
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/react/src/components/Forms/DatePicker/index.mdx
View File

@@ -132,6 +132,15 @@ By default, the DatePicker component uses the CunninghamProvider locale.
<Story id="components-forms-datepicker--cunningham-locale"/>
</Canvas>
## Timezone management
By default, the component uses the user's local timezone. When a timezone is passed, dates are selected at midnight in that specific timezone.
If a value or default value is provided, the component preserves the time unless the user clears the input.
When the input is cleared, the dates are reset to midnight in the current timezone.
The component accepts both UTC date-time strings and date-time strings with offsets from UTC.
However, it consistently returns the output in UTC time, ensuring uniformity across different timezone.
## Props
You can see the list of props below.