Update Datepicker onSelectedDateChanged signature to include isClearAction parameter

[bvedad]

• [X] I have followed the Your First Code Contribution section of the Contributing guide

Update Datepicker onSelectedDateChanged signature to include isClearAction parameter

#1366

Summary by CodeRabbit

• New Features
  • Enhanced the date picker functionality to include an indicator for clear actions, improving user interaction by signaling whether a date was cleared or changed.

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 62b2525c2b7af41f35c97e00a7d5b8f31ecfcf71

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
flowbite-react	Patch

Not sure what this means? Click here to learn what changesets are.

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

[vercel[bot]]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 4, 2024 3:29pm
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 4, 2024 3:29pm

[coderabbitai[bot]]

Walkthrough

The update involves enhancing the Datepicker component by introducing a new parameter isClearAction to the onSelectedDateChanged callback. This addition enables explicit handling of date clearing actions, enhancing functionality and user experience in scenarios where users need to reset their date inputs.

Changes

File Path	Change Summary
packages/ui/src/components/Datepicker/Datepicker.tsx	Added isClearAction parameter to onSelectedDateChanged in DatepickerProps; updated relevant functions to support this change.

Possibly related issues

• themesberg/flowbite-react#1366: The issue requests a feature to handle clear actions in the Datepicker, which is addressed by the isClearAction parameter added in this PR. This change allows developers to explicitly set the date to null when clearing.

🐰✨ A hop, a skip, a jump so high, A Datepicker change, oh my! Clear your dates, without dismay, For "isClearAction" leads the way! Celebrate, for bugs we fray! 🎉 🐰✨

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[SutuSebastian]

onChange prop should be returning Date | null in the first place, avoiding this workaround

[rluders]

onChange prop should be returning Date | null in the first place, avoiding this workaround

I'm not sure... 🤔 Let me think.

Update: Yeah, I think it makes sense.

[SutuSebastian]

Also, this has packages/ui changes, which should introduce a changeset, please run bun changeset in the root folder and follow instructions to bump the flowbite-react package to a patch, in the end u have to give it a changelog/summary of the PR, then commit the generated changeset.

[bvedad]

onChange prop should be returning Date | null in the first place, avoiding this workaround

@SutuSebastian I agree with you but the reason why I proposed this implementation is because at the moment clear button does not clear the date to be null, but it resets it to the default value. To me this is counterintuitive but if developers decide for some reason to implement it that way I am not planning to be a bottleneck. This approach is harmless and it allows us to set dates to null if we want. If you want to I can implement it so onSelectedDateChanged accept Date | null but then I will need to change implementation of clear from:

const clearDate = () => {
    changeSelectedDate(defaultDate, true, true);
    if (defaultDate) {
      setViewDate(defaultDate);
    }
  };

to something like:

const clearDate = () => {
    changeSelectedDate(defaultDate, true, true);
    setViewDate(defaultDate);
  };

and as well change code from:

{showClearButton && (
  <button
    type="button"
    className={twMerge(theme.popup.footer.button.base, theme.popup.footer.button.clear)}
    onClick={() => {
      changeSelectedDate(defaultDate, true, true);
      if (defaultDate) {
        setViewDate(defaultDate);
      }
    }}
  >
    {labelClearButton}
  </button>
)}

to something like below:

{showClearButton && (
  <button
    type="button"
    className={twMerge(theme.popup.footer.button.base, theme.popup.footer.button.clear)}
    onClick={() => {
      changeSelectedDate(null, true, true);
      setViewDate(null);
    }}
  >
    {labelClearButton}
  </button>
)}

[bvedad]

Also, this has packages/ui changes, which should introduce a changeset, please run bun changeset in the root folder and follow instructions to bump the flowbite-react package to a patch, in the end u have to give it a changelog/summary of the PR, then commit the generated changeset.

Thanks for giving me this information. I have just generated changelog content and pushed it to this MR.

[bvedad]

Check comments ☝️

I have just checked them and I have performed the necessary changes.