Skip to content

Announce outline sidebar navigation state to screen readers - #2058

Open
jacobo-dominguez-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:a11y-sidebar-trigger
Open

jacobo-dominguez-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:a11y-sidebar-trigger

Conversation

@jacobo-dominguez-wgu

Copy link
Copy Markdown
Contributor

Description

Problem

The course outline sidebar's navigation controls did not expose their state to assistive technology, failing WCAG 4.1.2 Name, Role, Value (Level A).

  • The left navigation toggle did not announce whether the outline was expanded or collapsed.
  • The learner's current unit was not identifiable programmatically, so screen reader users had no reliable way to tell where they were within the course content.

Approach

Added the missing ARIA state attributes to the existing controls, keeping the markup and Paragon components otherwise unchanged.

Control File Change
Outline sidebar toggle (sequence nav / mobile) CourseOutlineTrigger.jsx aria-expanded={currentSidebar === ID} + aria-controls="outline-sidebar-outline"
In-tray header toggle components/CourseOutlineHeading.tsx aria-expanded (the tray only mounts when open, so the control is always in the expanded state) + aria-controls
Active unit link components/UnitLinkWrapper.tsx aria-current="page" when the unit is the active unit

Testing

Test case 1
  • Setup your favorite screen reader.
  • Go to any course and navigate the screen using the keyboard until you are on the outline sidebar trigger
image - The screen reader must indicate the state of the trigger whether is expanded or collapsed.

Test case 2

Inspect the outline sidebar trigger and outline sidebar active item using the browsers developer tools and verify:

  • Expandable navigation controls expose aria-expanded state (true/false) to assistive tech.
  • The current page/section is exposed via aria-current="page" where appropriate.

AI usage notice

Used Kiro to assist on this creation of this pr.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 11, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @jacobo-dominguez-wgu!

This repository is currently maintained by @openedx/committers-frontend-app-learning.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov

codecov Bot commented Sep 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.60%. Comparing base (09a89b7) to head (75d6d79).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2058   +/-   ##
=======================================
  Coverage   93.59%   93.60%           
=======================================
  Files         368      368           
  Lines        6015     6017    +2     
  Branches     1420     1418    -2     
=======================================
+ Hits         5630     5632    +2     
+ Misses        369      368    -1     
- Partials       16       17    +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants