fix(datepicker): datePicker now supports formatting of date

dhavalveera commented 3 months ago

🛠️ Enhancement: Added Date Formatting Support to DatePicker

This PR introduces date formatting support to the DatePicker component by leveraging the date-fns package. Users can now customize date formats such as dd-MMM-yyyy or dd MMM yyyy according to their preferences.

outputs/examples:

dd-MMM-yyyy // output => 11-Mar-2024

dd MMM yyyy // output => 11 Mar 2024

dd-MM-yyyyy // output => 11-03-2024

Summary by CodeRabbit

New Features
- Introduced a Datepicker component with configurable date formats and localization support.
- Added documentation for date format and localization settings in the Datepicker component.
Improvements
- Enhanced Datepicker tests to support various date formats.
- Updated Datepicker to use consistent date formatting and locale settings through date-fns.
Dependencies
- Added date-fns version 3.6.0 to support date formatting and localization.

stackblitz[bot] commented 3 months ago

Run & review this pull request in StackBlitz Codeflow.

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	❌ Failed (Inspect)			Jun 26, 2024 1:56am
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 26, 2024 1:56am

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance the Datepicker component by adding localization and customizable date formats, leveraging date-fns. This improves the component's usability across different locales and allows users to specify the desired date format. In essence, the updates focus on internationalization and formatting flexibility, enhancing both functionality and user experience.

Changes

Files / Groups	Change Summary
`apps/web/examples/datepicker/datepicker.format.tsx`	Introduced a Datepicker component with specific input format support, for both client and server-side rendering.
`apps/web/examples/datepicker/datepicker.localization.tsx`	Updated to support localization with language attribute and label names for the Datepicker component.
`apps/web/content/docs/components/datepicker.mdx`	Added documentation on using `inputFormat` prop and localization, emphasizing date formatting and `date-fns` usage.
`apps/web/examples/datepicker/index.ts`	Added export of `format` from `datepicker.format`.
`packages/ui/package.json`	Added `date-fns` dependency version `3.6.0`.
`packages/ui/src/.../Datepicker.spec.tsx`, `Datepicker.stories.tsx`	Updated test cases and stories to include date format and localization.
`packages/ui/src/components/Datepicker/Datepicker.tsx`	Added `AvailableLocales` type, `inputFormat`, and localization support to the Datepicker component.
`packages/ui/src/components/Datepicker/helpers.ts`	Enhanced `getFormattedDate` to use `date-fns` for date formatting and localization, added `AvailableLocales` type.
`packages/ui/src/components/Datepicker/helpers.spec.tsx`	Updated tests for `getFormattedDate` with date format string support, ensuring diverse locale formatting.
`packages/ui/src/components/Datepicker/DatepickerContext.tsx`	Changed `language` property to `AvailableLocales` type in `DatepickerContextProps`.

Poem

In the code so bright and true, Datepicker gained a skill anew, With formats diverse and locales wide, Days are shown with global pride. Thanks to date-fns we align, Dates sparkle like a user's sign. 🐰✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

SutuSebastian commented 3 months ago

btw, what code editor are u using @dhavalveera ? It seems to me that u are not formatting the code on-save, or at all.

dhavalveera commented 3 months ago

btw, what code editor are u using @dhavalveera ? It seems to me that u are not formatting the code on-save, or at all.

I'm using VSCode, and when I do save (Ctrl + S) it saves the files for me, but I'll check again

changeset-bot[bot] commented 3 months ago

⚠️ No Changeset found

Latest commit: dd540cebdb36e833df739d0426162784a0ecaac6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

rluders commented 2 months ago

@dhavalveera could you please rebase it with main? I want to get this one approved. :)

dhavalveera commented 2 months ago

@dhavalveera could you please rebase it with main? I want to get this one approved. :)

@rluders --- this conflicts, can't be done from my end, as I don't have the write access to this repository.

dhavalveera commented 2 months ago

@rluders --- it seems like I need to modify the helpers.ts where it's using new Intl.DateTimeFormat() as the language type is passed is getting incorrect, as date-fns package have locales as enUS whereas INTL needs it as en-US, any guidance please

dhavalveera commented 2 weeks ago

Hello @SutuSebastian , currently I'm facing an issue is like date-fns have different locales and the new Intl.DateTimeFormat() accepts the locales differently.

e.g. for date-fns it have locales like enUS, but whereas for Intl.DateTimeFormat() have locales like en-US due to which many Date Picker Helper Function & Test Cases are failing, how to handle this, can you please help/guide me on this, please 🙏

themesberg / flowbite-react