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(accordion): pass missing dividerProps to Divider #3392

Merged
merged 6 commits into from
Jul 6, 2024

Conversation

chirokas
Copy link
Contributor

@chirokas chirokas commented Jul 2, 2024

Closes #3390

📝 Description

Pass missing dividerProps to Divider

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Accordion component now supports dividerProps to customize dividers between items.
  • Tests

    • Added test cases to ensure dividerProps are correctly passed to the divider component within the Accordion.

Copy link

changeset-bot bot commented Jul 2, 2024

🦋 Changeset detected

Latest commit: 1f24ea4

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/accordion 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 Jul 2, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 6, 2024 7:53am

Copy link

vercel bot commented Jul 2, 2024

@chirokas 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 Jul 2, 2024

Walkthrough

The recent changes to the @nextui-org/accordion package fix a bug with the dividerProps in the Accordion component. Now, the AccordionGroup accepts dividerProps and correctly passes them to the Divider component. Additionally, tests have been added to verify that the dividerProps are properly handled and applied, ensuring the intended customizations, like changing the divider color with a CSS class, are functional.

Changes

Files Change Summaries
.../accordion/__tests__/accordion.test.tsx Added a test case to verify that dividerProps are correctly passed to the Divider component.
.../accordion/src/accordion.tsx Modified the AccordionGroup component to accept dividerProps and pass them to the Divider component when rendering dividers between accordion items.
.changeset/many-wasps-move.md Documented the new functionality that involves patching the @nextui-org/accordion package to pass missing dividerProps to the Divider.

Sequence Diagram(s)

No sequence diagrams as the changes are limited to extending a component property and adding a corresponding test case.

Assessment against linked issues

Objective Addressed Explanation
Fix the bug where dividerProps do not work in the Accordion component (#3390)

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 9daef56 and e260a1a.

Files selected for processing (3)
  • .changeset/many-wasps-move.md (1 hunks)
  • packages/components/accordion/tests/accordion.test.tsx (1 hunks)
  • packages/components/accordion/src/accordion.tsx (2 hunks)
Additional comments not posted (4)
.changeset/many-wasps-move.md (1)

1-5: Ensure completeness and clarity in changeset description.

The changeset message is brief and to the point. However, it would be beneficial to provide more context about the changes, such as why the dividerProps were missing and the impact of this fix.

Consider updating the description to:

---
"@nextui-org/accordion": patch
---

Pass missing `dividerProps` to Divider in Accordion component. This fix allows customization of the Divider's properties, such as color, which was previously not possible.
packages/components/accordion/src/accordion.tsx (2)

22-22: Ensure dividerProps is correctly used within the component.

The addition of dividerProps in the destructuring assignment is correct. Ensure that this prop is passed to the Divider component where it is used.


49-49: Pass dividerProps to the Divider component.

This change correctly passes dividerProps to the Divider component, ensuring that additional properties can be applied to the Divider.

packages/components/accordion/__tests__/accordion.test.tsx (1)

311-328: Test case for dividerProps is well-implemented.

The test case correctly verifies that dividerProps are passed to the Divider component and that the specified className is applied.

@wingkwong wingkwong assigned jrgarciadev and unassigned wingkwong Jul 3, 2024
@wingkwong wingkwong added this to the v2.4.3 milestone Jul 3, 2024
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 e260a1a and b5ab0eb.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (1)
  • .changeset/many-wasps-move.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .changeset/many-wasps-move.md

Copy link
Contributor

@mauriciabad mauriciabad left a comment

Choose a reason for hiding this comment

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

Perfect!

@jrgarciadev
Copy link
Member

@chirokas please fix the conflicts

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 b5ab0eb and 1f24ea4.

Files selected for processing (1)
  • packages/components/accordion/tests/accordion.test.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/components/accordion/tests/accordion.test.tsx

@wingkwong wingkwong merged commit 8dce94e into nextui-org:canary Jul 6, 2024
7 of 8 checks passed
@chirokas chirokas deleted the fix/eng-1093 branch July 6, 2024 11:58
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] - dividerProps in Accordion not working
4 participants