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

feat(calendar): add CalendarPickerItem with auto-collapse on select #4021

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

ds-spec
Copy link

@ds-spec ds-spec commented Nov 10, 2024

#4002

📝 Description

This pull request introduces an auto-collapse behavior to the CalendarPickerItem component within the DatePicker functionality. The new feature automatically collapses the header after a user selects either a month or year, streamlining the date selection process by reducing required user interactions.

⛳️ Current behavior (updates)

Currently, after selecting a year or month in the DatePicker:

The header remains expanded
Users need to manually collapse the header
Requires additional clicks to complete the date selection process

🚀 New behavior

With this enhancement:

Header automatically collapses after month selection
Header automatically collapses after year selection
Smoother transition between selection states
Reduced number of clicks needed to complete date selection

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

No - This enhancement maintains backward compatibility while improving the user experience.

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Enhanced the CalendarPickerItem component to control the expansion state of the calendar header through user interactions.
  • Bug Fixes

    • Updated button functionality to prevent default actions and event propagation, improving user experience.

@ds-spec ds-spec requested a review from jrgarciadev as a code owner November 10, 2024 10:09
Copy link

vercel bot commented Nov 10, 2024

@ds-spec 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

changeset-bot bot commented Nov 10, 2024

⚠️ No Changeset found

Latest commit: 5e4f5bb

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

Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

Walkthrough

The pull request modifies the CalendarPickerItem component by introducing a new import for useCalendarContext, which facilitates access to calendar-related context. A variable setIsHeaderExpanded is destructured from this context, allowing the component to manage the calendar header's expansion state. The button's onClick event handler is updated to prevent default actions, stop event propagation, and collapse the header when clicked, enhancing the component's interaction model.

Changes

File Path Change Summary
packages/components/calendar/src/calendar-picker-item.tsx Added import for useCalendarContext, destructured setIsHeaderExpanded, and updated button's onClick event handler to manage header state.

Possibly related PRs

Suggested reviewers

  • wingkwong
  • jrgarciadev

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1091377 and 5e4f5bb.

📒 Files selected for processing (1)
  • packages/components/calendar/src/calendar-picker-item.tsx (3 hunks)
🔇 Additional comments (2)
packages/components/calendar/src/calendar-picker-item.tsx (2)

12-13: LGTM: Clean import addition

The import is properly placed and necessary for the new functionality.


30-31: Verify CalendarProvider presence

The optional chaining on setIsHeaderExpanded suggests it might be undefined. Let's verify that this component is always used within a CalendarProvider context.

✅ Verification successful

Let me generate one more verification to check where CalendarPickerItem is being used within the component hierarchy.


CalendarPickerItem is properly wrapped within CalendarProvider

The verification shows that CalendarPickerItem is used within a proper context hierarchy:

  • CalendarPickerItem is used inside CalendarPicker component
  • CalendarPicker is rendered within CalendarBase
  • CalendarBase is wrapped by CalendarProvider in both Calendar and RangeCalendar components

The optional chaining on setIsHeaderExpanded is just a defensive programming practice, not an indication of missing context. The component is properly integrated within the context hierarchy.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for CalendarProvider usage and CalendarPickerItem imports
echo "Checking CalendarProvider usage:"
rg -A 3 "CalendarProvider|CalendarContext.Provider"

echo -e "\nChecking CalendarPickerItem imports and usage:"
rg -A 3 "CalendarPickerItem"

Length of output: 5248


Script:

#!/bin/bash
# Check the calendar-picker.tsx implementation to see how CalendarPickerItem is used
echo "Checking calendar-picker.tsx implementation:"
cat packages/components/calendar/src/calendar-picker.tsx

# Check calendar-base.tsx to see how CalendarPicker is integrated
echo -e "\nChecking calendar-base.tsx implementation:"
cat packages/components/calendar/src/calendar-base.tsx

Length of output: 10041

Comment on lines +53 to +57
onClick={(e) => {
e.preventDefault();
e.stopPropagation();
setIsHeaderExpanded?.(false);
}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Preserve original onClick functionality

While the implementation achieves the auto-collapse objective, it overrides any existing onClick handler passed through props. Consider preserving the original functionality.

-      onClick={(e) => {
-        e.preventDefault();
-        e.stopPropagation();
-        setIsHeaderExpanded?.(false);
-      }}
+      onClick={(e) => {
+        e.preventDefault();
+        e.stopPropagation();
+        setIsHeaderExpanded?.(false);
+        otherProps.onClick?.(e);
+      }}

Committable suggestion skipped: line range outside the PR's diff.

Copy link

vercel bot commented Nov 10, 2024

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 Nov 10, 2024 3:58pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 10, 2024 3:58pm

@jrgarciadev
Copy link
Member

@wingkwong please review

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. please add a changeset
  2. please add a test case
  3. the PR change breaks the existing behaviour: open month and year selector, select any year, the picker item will be closed without selecting the target value. Also apply month.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants