fix(date-picker): filter out non-DOM props to prevent console errors

[ryo-manba]

Closes #2823

📝 Description

This PR addresses console errors that appear when unrecognized props are passed to the DOM elements in the DatePicker. Props like placeholderValue and hideTimeZone are now handled to prevent them from being passed to the DOM.

Test Steps

1. Display a DatePicker with the following setup:

  return (
    <DatePicker
      isRequired
      hideTimeZone={true}
      label="Activity date"
      placeholderValue={now(getLocalTimeZone())}
    />
  );
};

2. Open the calendar and verify that no warnings are displayed.

Before

datepicker-warning-before-fix.mov

After

datepicker-no-warning-after-fix.mov

⛳️ Current behavior (updates)

Passing unrecognized props like placeholderValue and hideTimeZone to the DatePicker triggers console errors.

🚀 New behavior

Unrecognized props are now filtered out before rendering, preventing any console errors.

💣 Is this a breaking change (Yes/No):

No.

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Improved error handling in the DatePicker component to prevent console errors related to inappropriate prop types.
• Refactor
  • Enhanced type declarations and function return types in DatePicker functionalities for better code clarity and reliability.
  • Updated value handling in DatePicker to ensure more robust and fault-tolerant input processing.
• Tests
  • Added new props and console spies for comprehensive testing coverage in the DatePicker component.

[changeset-bot]

🦋 Changeset detected

Latest commit: 03b1d0c

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

This PR includes changesets to release 2 packages

Name	Type
@nextui-org/date-picker	Patch
@nextui-org/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

[coderabbitai]

Walkthrough

The recent patch addresses errors related to non-DOM props in the @nextui-org/date-picker component. Changes include refining type declarations and explicitly specifying return types for several functions, alongside improved handling of minValue and maxValue using nullish coalescing operators. This ensures props are correctly filtered out before being passed to DOM elements, reducing console errors.

Changes

File Path	Change Summary
.changeset/stale-cats-sell.md	Introduced a patch for handling non-DOM props in the DatePicker component.
.../date-picker/src/use-date-picker-base.ts	Modified popoverProps with explicit type and adjusted children assignment.
.../date-picker/src/use-date-picker.ts	Specified return types for functions and updated handling of minValue and maxValue.

Assessment against linked issues

Objective	Addressed	Explanation
Prevent non-DOM prop errors in console [#2823]	✅
Ensure all passed props function correctly without causing console errors [#2823]	✅
Eliminate specific errors such as placeholderValue and hideTimeZone being unrecognized [#2823]	❓	The changes suggest a generic approach to filtering props, but specifics on these props are not detailed.

---

Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between de90928 and 03b1d0c.

Files selected for processing (1)

• packages/components/date-picker/tests/date-picker.test.tsx (2 hunks)

Files not reviewed due to errors (1)

• packages/components/date-picker/tests/date-picker.test.tsx (no review received)

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 22, 2024 1:59pm
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 22, 2024 1:59pm

[wingkwong]

Can we also have some tests in date picker to prevent this issue in the future?

[ryo-manba]

@wingkwong
I've tightened type constraints in the useDatePicker hooks without using the as keyword.
This should statically prevent the problem in the future.

[wingkwong]

@ryo-manba maybe also check once in useCalendar

[ryo-manba]

@wingkwong
Thanks for the comment. I added a test.

[jrgarciadev]

Thank. you! @ryo-manba