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(components): added aria label to chip close button #2855

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

Conversation

ahmadJT
Copy link

@ahmadJT ahmadJT commented Apr 24, 2024

Closes #2802

📝 Description

  • The chip component close button was missing an aria-label attribute. This causes the accessibility tests to fail for a chip with a close button

⛳️ Current behavior (updates)

  • No aria-label attribute on the button component
    Screenshot 2024-04-24 at 07 04 39 (2)
    Screenshot 2024-04-24 at 07 04 44 (2)

🚀 New behavior

  • Added aria-label attribute
    Screenshot 2024-04-24 at 07 03 49 (2)
    Screenshot 2024-04-24 at 07 04 00 (2)

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

  • No

📝 Additional Information

Summary by CodeRabbit

  • Accessibility Improvements
    • Enhanced accessibility for the close button in the Chip component by adding an aria-label.

Copy link

changeset-bot bot commented Apr 24, 2024

⚠️ No Changeset found

Latest commit: aff459b

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
Contributor

coderabbitai bot commented Apr 24, 2024

Walkthrough

The update to the Chip component introduces an aria-label for the close button, enhancing accessibility by providing a descriptive label when the isCloseable property is true.

Changes

File Path Change Summary
packages/components/chip/src/... Added aria-label="close-button" to close button in Chip.

Possibly related issues


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1ba2d02 and aff459b.
Files selected for processing (1)
  • packages/components/chip/src/chip.tsx (1 hunks)
Additional comments not posted (1)
packages/components/chip/src/chip.tsx (1)

36-40: The addition of the aria-label attribute to the close button when isCloseable is true enhances accessibility, aligning with the PR's objectives.

Ensure that the aria-label integrates seamlessly with other attributes provided by getCloseButtonProps().


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.

Copy link

vercel bot commented Apr 24, 2024

@arkmadj 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

vercel bot commented Apr 24, 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 Apr 24, 2024 6:09am

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.

  1. add it to getCloseButtonProps instead
  2. add a changeset

Copy link

@j-vitali j-vitali left a comment

Choose a reason for hiding this comment

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

ok

@wingkwong wingkwong changed the base branch from main to canary April 28, 2024 14:46
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.

[BUG] - Chip has accessibility issue when it has close button
4 participants