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(calendar): disable button picker in calendar if isDisabled is true #3358

Merged
merged 3 commits into from
Jul 6, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Jun 29, 2024

Closes #3357

📝 Description

passing isDisabled to buttonPickerProps

⛳️ Current behavior (updates)

image image

🚀 New behavior

image

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

No

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes

    • Disabled the button picker in the calendar when isDisabled is set to true, resolving issue [BUG] - Calendar #3357.
  • Tests

    • Added a test to ensure the month & year picker does not open when isDisabled is true.

Copy link

linear bot commented Jun 29, 2024

Copy link

vercel bot commented Jun 29, 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 Jun 29, 2024 3:36am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 29, 2024 3:36am

Copy link

changeset-bot bot commented Jun 29, 2024

🦋 Changeset detected

Latest commit: ead1831

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

This PR includes changesets to release 3 packages
Name Type
@nextui-org/calendar Patch
@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
Contributor

coderabbitai bot commented Jun 29, 2024

Walkthrough

The recent update to the @nextui-org/calendar package adds functionality to disable the month and year picker buttons when the isDisabled prop is set to true. This change ensures that, if the calendar is disabled, the picker controls are also appropriately non-interactive, specifically addressing issue #3357. A corresponding test case was added to verify this behavior.

Changes

File Path Change Summary
.changeset/friendly-pumas-brush.md Added documentation summarizing the patch for the @nextui-org/calendar package.
.../calendar/__tests__/calendar.test.tsx Introduced a new test case to ensure the month & year picker does not open when isDisabled.
.../calendar/src/use-calendar.ts Integrated mergeProps to merge existing props with the isDisabled attribute.

Assessment against linked issues

Objective (Issue #3357) Addressed Explanation
Disable pickers when isDisabled is used

Tip

Early access features
  • OpenAI gpt-4o model for reviews and chat.

Note:

  • You can disable early access features from the CodeRabbit UI or by setting early_access: false in the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are always opted into early access features.

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>.
    • 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.

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: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 78d4216 and ead1831.

Files selected for processing (3)
  • .changeset/friendly-pumas-brush.md (1 hunks)
  • packages/components/calendar/tests/calendar.test.tsx (1 hunks)
  • packages/components/calendar/src/use-calendar.ts (2 hunks)
Files skipped from review due to trivial changes (2)
  • .changeset/friendly-pumas-brush.md
  • packages/components/calendar/tests/calendar.test.tsx
Additional comments not posted (2)
packages/components/calendar/src/use-calendar.ts (2)

11-11: Import statement update looks good.

The addition of mergeProps from @react-aria/utils is appropriate for the changes made.


79-79: LGTM!

The use of mergeProps to include the isDisabled property in buttonPickerProps is correct and ensures that the button picker respects the isDisabled state.

However, ensure this change is properly reflected in all relevant parts of the codebase.

Verification successful

LGTM!

The use of mergeProps to include the isDisabled property in buttonPickerProps is correct and ensures that the button picker respects the isDisabled state. The change is properly reflected in all relevant parts of the codebase.

  • calendar-base.tsx: Properly passes buttonPickerProps to CalendarHeader.
  • calendar-header.tsx: Properly spreads buttonPickerProps onto the Button component.
  • use-calendar.ts: Merges isDisabled into buttonPickerProps and passes it correctly.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify all references to `buttonPickerProps` to ensure they handle the `isDisabled` property correctly.

# Test: Search for the usage of `buttonPickerProps` in the codebase. Expect: Proper handling of `isDisabled` property.
rg --type-add 'tsx' --type-add 'ts' --type tsx,ts 'buttonPickerProps'

Length of output: 125



Script:

#!/bin/bash
# Description: Verify all references to `buttonPickerProps` to ensure they handle the `isDisabled` property correctly.

# Test: Search for the usage of `buttonPickerProps` in the codebase. Expect: Proper handling of `isDisabled` property.
rg --type-add 'tsx:*.tsx' --type-add 'ts:*.ts' --type tsx,ts 'buttonPickerProps'

Length of output: 111



Script:

#!/bin/bash
# Description: Verify all references to `buttonPickerProps` to ensure they handle the `isDisabled` property correctly.

# Test: Search for the usage of `buttonPickerProps` in the codebase. Expect: Proper handling of `isDisabled` property.
rg --type-add 'tsx:*.tsx' --type tsx 'buttonPickerProps'
rg --type-add 'ts:*.ts' --type ts 'buttonPickerProps'

Length of output: 1831



Script:

#!/bin/bash
# Description: Inspect the context around references to `buttonPickerProps` to verify the handling of the `isDisabled` property.

# Check context of `buttonPickerProps` in calendar-base.tsx
rg --type-add 'tsx:*.tsx' --type tsx -C 5 'buttonPickerProps' packages/components/calendar/src/calendar-base.tsx

# Check context of `buttonPickerProps` in calendar-header.tsx
rg --type-add 'tsx:*.tsx' --type tsx -C 5 'buttonPickerProps' packages/components/calendar/src/calendar-header.tsx

# Check context of `buttonPickerProps` in use-calendar.ts
rg --type-add 'ts:*.ts' --type ts -C 5 'buttonPickerProps' packages/components/calendar/src/use-calendar.ts

Length of output: 3211

@jrgarciadev jrgarciadev merged commit fd4b720 into canary Jul 6, 2024
8 checks passed
@jrgarciadev jrgarciadev deleted the fix/eng-1069 branch July 6, 2024 07:33
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] - Calendar
2 participants