Skip to content

docs(a11y): a11y migration docs with JIRA issues#6159

Open
nikkimk wants to merge 9 commits intomainfrom
nikkimk/a11y-consultation
Open

docs(a11y): a11y migration docs with JIRA issues#6159
nikkimk wants to merge 9 commits intomainfrom
nikkimk/a11y-consultation

Conversation

@nikkimk
Copy link
Copy Markdown
Contributor

@nikkimk nikkimk commented Apr 9, 2026

Description

  • Updates a11y migration docs to include open tickets
  • Adds picker a11y migration docs

Motivation and context

  • Need to be able to identify which open a11y issues are resolved by 2nd-gen components.
  • Need to provide a11y migration docs in order to test picker with overlay solution and focus management proposal.

Related issue(s)

  • fixes SWC-1648
  • peding picker migration a11y docs ticket

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

  • A11y migration docs changes
    1. Go here
    2. Review a11y migration docs changes
    3. Ensure each component lists open a11y issues (if applicable)

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

Accessibility testing checklist

Required: Complete each applicable item and document your testing steps (replace the placeholders with your component-specific instructions).

  • Keyboard (required — document steps below) — What to test for: Focus order is logical; Tab reaches the component and all interactive descendants; Enter/Space activate where appropriate; arrow keys work for tabs, menus, sliders, etc.; no focus traps; Escape dismisses when applicable; focus indicator is visible.

    1. Go here
    2. Do this action
    3. Expect this result
  • Screen reader (required — document steps below) — What to test for: Role and name are announced correctly; state changes (e.g. expanded, selected) are announced; labels and relationships are clear; no unnecessary or duplicate announcements.

    1. Go here
    2. Do this action
    3. Expect this result

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 9, 2026

⚠️ No Changeset found

Latest commit: 5fbaf3a

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 Apr 9, 2026
@nikkimk nikkimk marked this pull request as ready for review April 9, 2026 15:10
@nikkimk nikkimk requested a review from a team as a code owner April 9, 2026 15:10
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

📚 Branch Preview Links

🔍 First Generation 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-6159

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.


---

## Known 1st-gen issues
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nice! Love this

<!-- Document title (editable) -->

# Divider accessibility migration analysis
# Illustrated message accessibility migration analysis
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Comment: Is this meant to be illustrated message? The file path has divider in it. Seems like a mistake or am I not reading this correctly?


- `heading-level` property (attribute `heading-level`): integers `2`–`6`, default `2`. The shadow tree renders exactly one `<h2>` … `<h6>` matching that value. Values outside `2`–`6` (including `1`) must be clamped or coerced to `2`–`6` (for example `1` → `2`), or rejected in types with a documented default—pick one policy and document it in Storybook.
- `heading` slot: accepts a `span` only (or equivalent documented phrasing: a single `span` wrapper as the slotted node). Do not allow slotted `<h1>`–`<h6>`; authors must not put heading elements in light DOM for this slot. Implementation may validate in dev and warn or ignore invalid slotted tags.
- Optional `heading` attribute: when used, its text is rendered as the title inside the shadow heading (alongside or instead of slot content per product rules—document the precedence if both exist).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Comment: As a note on this optional, I chatted with @5t3ph and since we are severing the dependency with 1st gen, we removed the fallback to heading attributes. Instead gen2 only uses slots. Open to discuss further though: #6150 (comment)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do we want to make a shim for this and a deprecation notice? @cdransf does it very well in this PR: #6113

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Do you have the file where that happens in the PR? I did a search on "deprecated" and couldn't find the example.

But that's a good question! I don't know the answer. If there is a hard dependency cut off from 1st gen, then maybe not? What do y'all think @5t3ph @caseyisonit @rubencarvalho ?

@@ -0,0 +1,148 @@
<!-- Generated breadcrumbs - DO NOT EDIT -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think claude must have did these backwards somehow. This file path is for illustrated message and has divider content. The path also looks a little funny below:

CONTRIBUTOR-DOCS / Project planning / Components / Illustrated Message / Divider accessibility migration analysis

Copy link
Copy Markdown

@miwha-adobe miwha-adobe left a comment

Choose a reason for hiding this comment

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

Seems like maybe there was a mixup in the doc path / content between Illustrated Message and Divider

@nikkimk nikkimk requested a review from miwha-adobe April 9, 2026 19:19
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.

2 participants