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.

Sign up for GitHub

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

Jump to bottom

fix: update accordion item heading tag to be customizable #2265

Merged
merged 8 commits into from May 13, 2024
Merged

fix: update accordion item heading tag to be customizable #2265

merged 8 commits into from May 13, 2024

Conversation

outputboy
Copy link
Contributor

@outputboy outputboy commented Jan 19, 2024 •
edited by coderabbitai bot

📝 Description

Make the Accordion Item heading tag customizable, not always h2 . This is good for a11y because it's recommended to have hierarchical headings in a web page.

⛳️ Current behavior (updates)

Accordion Item heading tag is locked to h2

🚀 New behavior

Users are able to pass in tag div or h3 via props HeadingComponent as needed

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

No

Summary by CodeRabbit

  • New Features
    • Enhanced the AccordionItem component with a customizable HeadingComponent prop for improved accessibility compliance and user experience.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 19, 2024 •
edited

🦋 Changeset detected

Latest commit: 72be5ab

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

@vercel Vercel
Copy link

vercel bot commented Jan 19, 2024 •
edited

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 May 5, 2024 4:02am

@vercel Vercel
Copy link

vercel bot commented Jan 19, 2024

Someone is attempting to deploy a commit to the NextUI Team on Vercel.

A member of the Team first needs to authorize it.

jrgarciadev
jrgarciadev requested changes Mar 3, 2024
View reviewed changes
.changeset/heavy-hairs-join.md Outdated Show resolved Hide resolved
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 21, 2024 •
edited

Walkthrough

The updates aim to enhance the accessibility of the AccordionItem component by introducing a new HeadingComponent prop for customizing heading tags across various files. This improvement empowers developers to tailor heading tags for better web accessibility, aligning with standards and enriching the user experience.

Changes

File Change Summary
.../accordion/src/accordion-item.tsx Introduced HeadingComponent prop to customize heading tags for improved accessibility.
.../accordion/src/base/accordion-item-base.tsx Added HeadingComponent to Props interface for heading tag customization, imported As from @nextui-org/system.
.../accordion/src/use-accordion-item.ts Added HeadingComponent parameter with default value "h2" to useAccordionItem for customizing heading tags.

Assessment against linked issues

Objective Addressed Explanation
[BUG] - No option to change AccordionItem's title tag from h2 to something else (Issue #2950) ✅

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Apr 21, 2024
View reviewed changes
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

.changeset/heavy-hairs-join.md Outdated Show resolved Hide resolved
@outputboy @coderabbitai
Update .changeset/heavy-hairs-join.md
a0c14e8 
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@wingkwong wingkwong changed the base branch from main to canary April 28, 2024 14:55
coderabbitai[bot]
coderabbitai bot reviewed May 5, 2024
View reviewed changes
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 06e9bc5 and 72be5ab.
Files selected for processing (2)
  • .changeset/heavy-hairs-join.md (1 hunks)
  • apps/docs/content/docs/components/accordion.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • .changeset/heavy-hairs-join.md
Additional comments not posted (1)
apps/docs/content/docs/components/accordion.mdx (1)

223-238: The addition of the HeadingComponent prop in the Accordion Item Props table is well-documented and aligns with the PR's objective to enhance accessibility by allowing customizable heading tags. This change should help users maintain a semantic HTML structure more effectively.

@jrgarciadev jrgarciadev merged commit 10497f1 into nextui-org:canary May 13, 2024
7 of 8 checks passed
@jrgarciadev jrgarciadev added this to the v2.3.7 milestone May 13, 2024
@github-actions github-actions bot mentioned this pull request May 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai left review comments

@jrgarciadev jrgarciadev jrgarciadev approved these changes

@wingkwong wingkwong wingkwong approved these changes

Assignees

@jrgarciadev jrgarciadev

Labels
None yet
Projects
None yet
Milestone
v2.3.7
Development

Successfully merging this pull request may close these issues.

[BUG] - No option to change AccordionItem's title tag from h2 to something else
3 participants
@outputboy @jrgarciadev @wingkwong