Skip to content

docs(icon): accessibility migration plan#6483

Merged
nikkimk merged 7 commits into
mainfrom
nikkimk/icon-a11y
Jul 15, 2026
Merged

docs(icon): accessibility migration plan#6483
nikkimk merged 7 commits into
mainfrom
nikkimk/icon-a11y

Conversation

@nikkimk

@nikkimk nikkimk commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Description

In spectrum-web-components/CONTRIBUTOR-DOCS/03_project-planning/03_components/icon/accessibility-migration-analysis.md:

  • Documented recommendations for ARIA roles, states, and properties for the 2nd-gen Icon
  • Shadow DOM and cross-root ARIA considerations documented, including any limitations or required workarounds (e.g., ElementInternals, cross-root ARIA delegation)
  • Accessibility tree expectations documented, including expected node roles, names, states, and hierarchy
  • Keyboard interaction model fully specified, covering focus management, key bindings, roving tabindex or active-descendant patterns, and focus trapping where applicable
  • Testing requirements defined, including unit tests, integration tests, and manual screen reader testing matrix (JAWS, NVDA, VoiceOver)
  • Known 1st-gen accessibility issues cataloged with disposition (fix in 2nd-gen, defer, or won't fix) and linked to any open GitHub issues or bugs
  • Applicable WAI-ARIA design pattern identified with relevant ARIA roles documented
  • 1st-gen component analysis completed, covering current ARIA implementation, keyboard handling, existing test coverage, and known issues with dispositions

Motivation and context

The 2nd-gen migration is an opportunity to address known accessibility gaps, align with the latest WAI-ARIA Authoring Practices, and ensure the component meets WCAG 2.2 AA compliance.

Related issue(s)

  • resolves SWC-2332

Screenshots (if appropriate)


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

Review the Icon accessibility migration analysis

  • ARIA roles, states, and properties covered
  • Shadow DOM and cross-root ARIA considerations covered
  • Accessibility tree documented
  • Keyboard interaction fully specified
  • Testing requirements defined
  • Known 1st-gen issues cataloged with dispositions
  • Review the changes that include the adaptive dual-border guidance

@changeset-bot

changeset-bot Bot commented Jul 8, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1591ad4

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

@nikkimk nikkimk self-assigned this Jul 8, 2026
@nikkimk nikkimk added a11y Issues or PRs related to accessibility Status:Ready for review PR ready for review or re-review. High priority PR review PR is a high priority and should be reviewed ASAP skip_vrt Skip VRT build; mark UI Tests green without running Chromatic and removed Status:Ready for review PR ready for review or re-review. High priority PR review PR is a high priority and should be reviewed ASAP skip_vrt Skip VRT build; mark UI Tests green without running Chromatic labels Jul 8, 2026
nikkimk

This comment was marked as outdated.

nikkimk

This comment was marked as duplicate.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

📚 Branch Preview Links

🔍 Gen1 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6483

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@nikkimk nikkimk closed this Jul 8, 2026
nikkimk

This comment was marked as duplicate.

@nikkimk nikkimk reopened this Jul 8, 2026
@coveralls

coveralls commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 29422650215

Coverage remained the same at 96.257%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 39169
Covered Lines: 37903
Line Coverage: 96.77%
Relevant Branches: 6459
Covered Branches: 6017
Branch Coverage: 93.16%
Branches in Coverage %: Yes
Coverage Strength: 461.21 hits per line

💛 - Coveralls

@nikkimk nikkimk added Status:Ready for review PR ready for review or re-review. High priority PR review PR is a high priority and should be reviewed ASAP labels Jul 8, 2026
@nikkimk
nikkimk marked this pull request as ready for review July 8, 2026 17:06
@nikkimk
nikkimk requested a review from a team as a code owner July 8, 2026 17:06

@cdransf cdransf left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks great! ✨

@nikkimk
nikkimk requested a review from caseyisonit July 8, 2026 19:49
@nikkimk
nikkimk removed the request for review from caseyisonit July 10, 2026 18:57
@nikkimk nikkimk added the skip_vrt Skip VRT build; mark UI Tests green without running Chromatic label Jul 15, 2026
@nikkimk
nikkimk enabled auto-merge (squash) July 15, 2026 14:14
@nikkimk
nikkimk merged commit cdc87ab into main Jul 15, 2026
33 of 36 checks passed
@nikkimk
nikkimk deleted the nikkimk/icon-a11y branch July 15, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a11y Issues or PRs related to accessibility High priority PR review PR is a high priority and should be reviewed ASAP skip_vrt Skip VRT build; mark UI Tests green without running Chromatic Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants