Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(date-picker): adding props from calendarProps to the getCalendarProps #3773

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from

Conversation

macci001
Copy link
Contributor

@macci001 macci001 commented Sep 17, 2024

Closes #3769

📝 Description

The classNames in the calendarProps does not get applied to the calendar.

⛳️ Current behavior (updates)

So currently, the classNames in calendarProps are not propagated to the Calendar due to which the styling does not get applied.

calendarProps={{
    classNames: {
      grid: 'bg-red-800',
    },
}}

As of now, adding the above prop to the date-picker gives following result (does not apply the mentioned style to the grid i.e. bg-red-800):
Screenshot 2024-09-17 at 12 02 43 PM

🚀 New behavior

The PR propagates the calendarProps's classNames so that styling do get apply to them.

calendarProps={{
    classNames: {
      grid: 'bg-red-800',
    },
}}

After the changes in this PR, adding the above prop to the date-picker gives following result (applies the mentioned styling to the grid i.e. bg-red-800 ):
Screenshot 2024-09-17 at 12 04 15 PM

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

Summary by CodeRabbit

  • New Features

    • Enhanced the date picker component for improved styling flexibility by allowing users to apply custom class names more effectively.
  • Bug Fixes

    • Resolved issues with class name propagation in the calendar component, ensuring that styles are applied correctly.

Copy link

changeset-bot bot commented Sep 17, 2024

🦋 Changeset detected

Latest commit: 7f2fbe4

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

Copy link

vercel bot commented Sep 17, 2024

Someone is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

This update introduces a patch for the @nextui-org/date-picker package, specifically enhancing the getCalendarProps function to ensure that classNames are properly propagated within calendarProps. The changes allow for improved customization of the date picker component, enabling users to apply their own styles more effectively. Additionally, modifications to the useDatePicker function enhance how class names are merged and applied, improving the overall usability of the date picker.

Changes

Files Change Summary
.changeset/flat-pants-accept.md Updated getCalendarProps to propagate classNames in calendarProps.

Assessment against linked issues

Objective Addressed Explanation
classNames in calendarProps should be applied correctly (3769)

Possibly related PRs


Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bed4a59 and 7f2fbe4.

Files selected for processing (2)
  • .changeset/flat-pants-accept.md (1 hunks)
  • packages/components/date-picker/src/use-date-picker.ts (1 hunks)
Additional comments not posted (2)
.changeset/flat-pants-accept.md (1)

1-5: LGTM!

The changeset is well-formatted and clearly describes the purpose of the patch. The description aligns with the PR objectives and the AI-generated summary, providing a good understanding of the issue and the proposed fix.

packages/components/date-picker/src/use-date-picker.ts (1)

207-211: LGTM! The changes enhance the flexibility and customization of the Calendar component's styles.

The updated implementation in the getCalendarProps function correctly merges the classNames from calendarProps with the existing classNames using the clsx utility. This allows for greater flexibility in managing styles dynamically and ensures that both sets of classNames are applied correctly to the Calendar component.

The changes address the issue reported in #3769 where classNames specified in calendarProps were not being applied to the Calendar. With this fix, users can now effectively style the Calendar using calendarProps, meeting the expected behavior.

The changes are not breaking and do not alter the declarations of exported or public entities, making it a safe and beneficial update.


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
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>, please review it.
    -- 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 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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@macci001 macci001 marked this pull request as ready for review September 17, 2024 06:45
@wingkwong wingkwong requested review from wingkwong and removed request for jrgarciadev September 17, 2024 07:55
@wingkwong wingkwong self-assigned this Sep 17, 2024
@wingkwong wingkwong added this to the v2.5.0 milestone Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] - DatePicker calanderProps classnames not working
2 participants