Skip to content

Accessibility Issue fixes for the MenuList Header Items #3179

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

Merged
merged 5 commits into from
Jun 24, 2025

Conversation

shrivastavaajit
Copy link
Contributor

Fixes #
Work Item: W-13840369

Additional description


CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

  • First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
  • npm run lint:fix has been run and linting passes.
  • Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

  • CircleCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.
Required only if there are markup / UX changes
  • Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
  • Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
  • Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
  • While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

Copy link

welcome bot commented Jun 11, 2025

Thanks for opening this pull request! 💯

This is a community-driven project, and we can't do it without your participation. Please check out our contributing guidelines and review the Contributor Checklist if you haven't already, to make sure everything is squared away. CircleCI will take about 10 minutes to run through the same items that are on the Contributor checklist with a pass/fail check below. Please fix any issues that cause CircleCI to fail or ask for clarification--we try, but sometimes the errors can be unclear.
A maintainer will try to respond within 7 days. If you haven’t heard anything by then, please bump this thread. To ensure codebase quality, large code line changes may take more than 2 weeks to review, but may take longer depending on the number of pull requests in the queue. Feel free to ask for a status update at any time--you won't be bothering anyone.
Once feedback has been given, please reply to the feedback giver once the feedback on been addressed, so that they can continue the review.
If you need a release while you are waiting for a code review, you can publish a built tag to your own fork. See directions in the release README.

Copy link

Thanks for the contribution! It looks like @shrivastavaajit is an internal user so signing the CLA is not required. However, we need to confirm this.

@interactivellama
Copy link
Contributor

@shrivastavaajit Thanks for looking into fixing this.

The best fix is present in the component blueprints. Please update to that.
https://v1.lightningdesignsystem.com/components/menus/#With-Subheaders

 <ul role="group" aria-labelledby="menu-group-id-9">
          <li class="slds-dropdown__header slds-truncate" title="Menu Sub Heading" role="presentation" id="menu-group-id-9">
            <span>Menu Sub Heading</span>
          </li>
          <li class="slds-dropdown__item" role="presentation">
            <a href="#" role="menuitem">
              <span class="slds-truncate" title="Menu Item One">Menu Item One</span>
            </a>
          </li>
          <li class="slds-dropdown__item" role="presentation">
            <a href="#" role="menuitem">
              <span class="slds-truncate" title="Menu Item Two">Menu Item Two</span>
            </a>
          </li>
        </ul>
      </li>

I'm unsure about the aria-label on the separator have a heading-like relationship with the list items, since when the menu opens, the first item is selection and not the heading. I'm unsure how the assistive text user would ever hear the separator. What are you finding when you run NVDA?

From a coding perspective, if we introduce nested lists then the updated nested unordered lists might require changes to menu list to get the additional role="group" in there. We'd also need to close the list when the second header is present. https://github.com/salesforce/design-system-react/blob/master/components/utilities/menu-list/index.jsx#L106

I looked at the Lightning Components and it looks like this same issue might be a bug in their library still, too. https://developer.salesforce.com/docs/component-library/bundle/lightning-menu-subheader/example

Copy link
Contributor

@interactivellama interactivellama left a comment

Choose a reason for hiding this comment

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

Approved.

Copy link
Contributor

@interactivellama interactivellama left a comment

Choose a reason for hiding this comment

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

Approved.

@interactivellama
Copy link
Contributor

@shrivastavaajit Thank you for your contribution!

@interactivellama interactivellama merged commit c85a549 into salesforce:master Jun 24, 2025
5 checks passed
Copy link

welcome bot commented Jun 24, 2025

Congrats on merging your first pull request to Design System React! 🎉
If you have a moment, please fill out this five question survey, we would appreciate it.
On behalf of Salesforce's customers, partners, product specialists and employees, we would like offer sincere thanks and appreciation for helping make our user experience better. We look forward to working with you more in the future.
This definitely calls for a high five! Alt High Five

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