Skip to content

Add accessibility documentation for Layout sidebar row_placement: :none#3911

Open
liuliu-dev wants to merge 2 commits intomainfrom
liuliu/add-accessibility-doc-for-layout-sidebar
Open

Add accessibility documentation for Layout sidebar row_placement: :none#3911
liuliu-dev wants to merge 2 commits intomainfrom
liuliu/add-accessibility-doc-for-layout-sidebar

Conversation

@liuliu-dev
Copy link
Contributor

@liuliu-dev liuliu-dev commented Feb 4, 2026

What are you trying to accomplish?

Adds accessibility documentation warning about using row_placement: :none on the Layout component's sidebar as requested in https://github.com/github/accessibility-audits/issues/14738#issuecomment-3824258460

Screenshots

Integration

List the issues that this change affects.

Closes # (type the GitHub issue number after #)

Risk Assessment

  • Low risk the change is small, highly observable, and easily rolled back.
  • Medium risk changes that are isolated, reduced in scope or could impact few users. The change will not impact library availability.
  • High risk changes are those that could impact customers and SLOs, low or no test coverage, low observability, or slow to rollback.

What approach did you choose and why?

Anything you want to highlight for special attention from reviewers?

Accessibility

  • Fixes axe scan violation - This change fixes an existing axe scan violation.
  • No new axe scan violation - This change does not introduce any new axe scan violations.
  • New axe violation - This change introduces a new axe scan violation. Please describe why the violation cannot be resolved below.

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Added/updated previews (Lookbook)
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@changeset-bot
Copy link

changeset-bot bot commented Feb 4, 2026

⚠️ No Changeset found

Latest commit: 5c95834

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

@changeset-bot
Copy link

changeset-bot bot commented Feb 4, 2026

⚠️ No Changeset found

Latest commit: 4e64b76

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

@liuliu-dev liuliu-dev added the skip changeset Pull requests that don't change the library output label Feb 4, 2026
@liuliu-dev liuliu-dev marked this pull request as ready for review February 4, 2026 19:09
@liuliu-dev liuliu-dev requested a review from a team as a code owner February 4, 2026 19:09
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds accessibility documentation to warn developers about potential WCAG 1.4.10 Reflow issues when using row_placement: :none on the Layout component's sidebar. The documentation clarifies that this setting hides the sidebar at narrow viewports, which could create accessibility problems if the sidebar contains essential content.

Changes:

  • Added accessibility warning about row_placement: :none to the main Layout component documentation
  • Updated the row_placement parameter description to include the same accessibility warning

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
app/components/primer/alpha/layout.rb Added accessibility documentation in both the component-level accessibility section and the sidebar parameter description
static/info_arch.json Updated the corresponding JSON metadata with the same accessibility documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

"type": "Symbol",
"default": "N/A",
"description": "Sidebar placement when `Layout` is in row mode. One of `:end`, `:none`, or `:start`."
"description": "Sidebar placement when `Layout` is in row mode. One of `:end`, `:none`, or `:start`. **Note:** Using `:none` hides the sidebar at narrow viewports, which may cause WCAG 1.4.10 Reflow issues if the sidebar contains essential content."
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

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

The documentation text differs slightly between the two locations. In this file, it says "WCAG 1.4.10 Reflow issues" while in layout.rb it says "WCAG 1.4.10 Reflow failures". These should use consistent terminology. Consider using "failures" in both places to be more technically accurate.

Suggested change
"description": "Sidebar placement when `Layout` is in row mode. One of `:end`, `:none`, or `:start`. **Note:** Using `:none` hides the sidebar at narrow viewports, which may cause WCAG 1.4.10 Reflow issues if the sidebar contains essential content."
"description": "Sidebar placement when `Layout` is in row mode. One of `:end`, `:none`, or `:start`. **Note:** Using `:none` hides the sidebar at narrow viewports, which may cause WCAG 1.4.10 Reflow failures if the sidebar contains essential content."

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip changeset Pull requests that don't change the library output

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants