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

components(AccordianPanel): fix isOpen and setIsOpen not working #1404

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

Conversation

NiteshSingh17
Copy link

@NiteshSingh17 NiteshSingh17 commented May 27, 2024

Summarize the changes made and the motivation behind them.

Reference related issues using # followed by the issue number.

If there are breaking API changes - like adding or removing props, or changing the structure of the theme - describe them, and provide steps to update existing code.

Changes

  • fix setOpen and isOpen prop not working for AccordionPanel

issue:
#735

Summary by CodeRabbit

  • New Features
    • Enhanced Accordion component to allow child components to override default properties, providing more customization options for users.

Copy link

changeset-bot bot commented May 27, 2024

⚠️ No Changeset found

Latest commit: 04e6848

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

vercel bot commented May 27, 2024

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

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2024 5:34pm
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2024 5:34pm

Copy link
Contributor

coderabbitai bot commented May 27, 2024

Walkthrough

The recent update in Accordion.tsx enhances the AccordionComponent by making it more flexible. It now allows child components to override default properties, such as alwaysOpen, arrowIcon, flush, isOpen, and setOpen. This change improves the component's adaptability to various use cases.

Changes

File Change Summary
packages/ui/src/components/Accordion/Accordion.tsx Updated the AccordionComponent to enable child components to override default props.

Poem

In the land of code where changes flow,
The Accordion learns to bend and grow.
With props that flex and options bright,
Each child can now set its own light.
Adapt and shine, oh code so grand,
A better UI at our command. 🌟


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.

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 full the 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 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 UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between b2640bc and 04e6848.
Files selected for processing (1)
  • packages/ui/src/components/Accordion/Accordion.tsx (1 hunks)
Additional comments not posted (3)
packages/ui/src/components/Accordion/Accordion.tsx (3)

52-60: The state management for toggling panels appears correctly implemented.


52-60: Theme management and class application using mergeDeep and twMerge are correctly implemented.


52-60: Ensure the logic for overriding props in cloneElement is correct and efficient.

Verification successful

The search did not find any similar patterns in other components. Therefore, let's manually verify the logic for overriding props in the provided code snippet.

The code snippet uses the cloneElement function to override certain props for child components. The nullish coalescing operator (??) is used to provide default values only when the child does not specify them. This approach ensures that child components can override the default props if needed.

The logic appears to be correct and efficient. Each prop is checked using the nullish coalescing operator, and the isOpen and setOpen props are conditionally set based on the current state.

  • The alwaysOpen prop is overridden with child.props.alwaysOpen ?? alwaysOpen.
  • The arrowIcon prop is overridden with child.props.arrowIcon ?? arrowIcon.
  • The flush prop is overridden with child.props.flush ?? flush.
  • The isOpen prop is overridden with child.props.isOpen ?? isOpen === i.
  • The setOpen prop is overridden with child.props.setOpen ?? (() => setOpen(isOpen === i ? -1 : i)).

This ensures that the child components receive the correct props, either from their own props or from the parent component's state.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the logic for overriding props in `cloneElement` by checking similar patterns in other components.

# Test: Search for similar patterns in other components. Expect: Consistent usage of nullish coalescing operator.
rg --type typescript $'cloneElement\($_, {'

Length of output: 146



Script:

#!/bin/bash
# Description: Verify the logic for overriding props in `cloneElement` by checking similar patterns in other components.

# Test: Search for similar patterns in other components. Expect: Consistent usage of nullish coalescing operator.
rg --type typescript 'cloneElement\(\$_, \{'

Length of output: 81



Script:

#!/bin/bash
# Description: Verify the logic for overriding props in `cloneElement` by checking similar patterns in other components.

# Test: Search for similar patterns in other components. Expect: Consistent usage of nullish coalescing operator.
rg --type ts 'cloneElement\(\$_, \{'

Length of output: 38

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.

1 participant