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

Accordion Tree Component (recursive). #3778

Closed
wants to merge 3 commits into from

Conversation

buchananwill
Copy link

@buchananwill buchananwill commented Sep 18, 2024

Closes #

📝 Description

Accordion Tree component that uses the existing Accordion to recursively render child accordions from hierarchical data.

⛳️ Current behavior (updates)

This doesn't modify any existing components, but augments the Accordion with an AccordionTree.

🚀 New behavior

A recursive implementation of Accordion.

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

No.

📝 Additional Information

I set a couple of default classNames to make the accordion more compact, as this works better when there are nested layers.

Summary by CodeRabbit

  • New Features

    • Introduced the AccordionTree component for a hierarchical accordion interface with nested items.
    • Enhanced customization options for displaying tree-like structures.
  • Improvements

    • Improved flexibility and adaptability for various use cases with customizable props.

Copy link

changeset-bot bot commented Sep 18, 2024

⚠️ No Changeset found

Latest commit: 3b77e2e

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 Sep 18, 2024

@buchananwill 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 18, 2024

Walkthrough

The changes introduce a new AccordionTree component within the accordion-tree.tsx file, which provides a hierarchical accordion interface for displaying nested items. This component builds upon existing Accordion and AccordionItem components, allowing for a flexible tree-like structure. It defines two new interfaces, AccordionTreeItemProps and AccordionTreeProps, to manage the properties of items and the component itself. The AccordionTree is designed for easy customization and is implemented as a forward ref to enhance its usability in parent components.

Changes

Files Change Summary
packages/components/accordion/src/accordion-tree.tsx - Added interface AccordionTreeItemProps
- Added interface AccordionTreeProps
- Added const AccordionTree
- Added export default AccordionTree

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bed4a59 and 3b77e2e.

Files selected for processing (1)
  • packages/components/accordion/src/accordion-tree.tsx (1 hunks)
Additional comments not posted (5)
packages/components/accordion/src/accordion-tree.tsx (5)

9-13: LGTM!

The AccordionTreeItemProps interface is well-defined, extending AccordionItemProps correctly and adding appropriate new props for the accordion tree functionality.


15-17: LGTM!

The AccordionTreeProps interface is well-defined, extending AccordionProps correctly and adding the required items prop for the accordion tree data.


19-64: LGTM!

The AccordionTree component is well-implemented, utilizing forward ref, destructuring props effectively, and recursively rendering nested accordions based on the provided data. The code is clean, readable, and follows good practices.


66-66: LGTM!

Setting the displayName to 'NextUI.AccordionTree' is a good practice for improving the readability of component hierarchies in development tools.


68-68: LGTM!

Exporting the AccordionTree component as the default export is a common and expected way to make the component available for use in other parts of the codebase.


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.

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.

please add the following

  • changeset
  • test cases
  • storybook
  • documentation
  • demo screencast

@wingkwong
Copy link
Member

Closing due to inactivity

@wingkwong wingkwong closed this Oct 6, 2024
@buchananwill
Copy link
Author

buchananwill commented Oct 6, 2024 via email

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.

2 participants