Skip to content

fix: resolve accessibility issue by adding aria label to caret component #292

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

AhalyaPai
Copy link

@AhalyaPai AhalyaPai commented Jan 30, 2025

This PR aims to resolve an accessibility issue by adding an ARIA label to the Caret component.

Motivation and Context

We use Stoplight elements in our application, and while scanning for accessibility issues, we discovered this problem

Description

ARIA commands must have an accessible name: A div with the role of 'button' should include an aria-label to provide an accessible name.

Picture1
Picture2

How Has This Been Tested?

Testing was conducted locally using the Axe DevTools browser extension for web accessibility testing.

Steps

  1. Install Axe DevTools: If you haven't already, install the Axe DevTools extension for your browser. It's available for Chrome and Firefox.

    Chrome extension
    https://chromewebstore.google.com/detail/axe-devtools-web-accessib/lhdoppojpmngadmnindnejefpokejbdd

    Firefox extension
    https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/

  2. Open the Web Page: Navigate to the web page you want to test for accessibility issues.
    E.g.: http://localhost:6006/?path=/story/combiners--array-one-of

  3. Open Developer Tools: Right-click on the page and select "Inspect"

  4. Access Axe DevTools: In the Developer Tools panel, look for the "axe DevTools" tab. Click on it to open the Axe DevTools interface.

  5. Run an Accessibility Scan: Click the "Full Page Scan" button within the Axe DevTools tab. This will start the accessibility scan of the current page.

  6. Review the Results: Once the scan is complete, Axe DevTools will display a list of accessibility issues found on the page. The issues are categorized by severity (e.g., critical, serious, moderate, minor).

Screenshot(s)/recordings(s)

Before
Picture3

After
Picture4

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

@AhalyaPai
Copy link
Author

I have updated the PR with screenshots. Can I get a review on this, please?

@AhalyaPai
Copy link
Author

@bhaskarsontakke @SB-akshaythakar @SB-pradeep-bande @prafullaAtSB

Hi All, Can anyone please review this?

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