Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix: heading completion selector added to aria-label (fixes #561) #562

Merged
merged 2 commits into from
Jul 8, 2024
Merged

Fix: heading completion selector added to aria-label (fixes #561) #562

merged 2 commits into from
Jul 8, 2024

Conversation

kirsty-hames
Copy link
Contributor

Fixes #561

Fix

Added .js-a11y-completion-description selector to heading completion aria-label instead of targeting generic .aria-label selector to update completion.

This will prevent functionality clashes between elements of a shared selector. For example, using a11y_alt_text helper within a displayTitle, as per the associated issue.

Testing

  1. Use the a11y_alt_text helper within a displayTitle. Note, you'll need to test this on a component that requires interaction rather than in view completion. For example, an Accordion title.
    "displayTitle": "I wish I had {{a11y_alt_text '$5bn' 'five billion dollars'}}",

  2. Go to the title within your course and inspect (or use a screen reader).
    Title should read "Incomplete. I wish I had five billion dollars"

  3. Interact with component so all items complete.
    Title should read "Complete. I wish I had five billion dollars"

@kirsty-hames kirsty-hames self-assigned this Jul 3, 2024
@kirsty-hames kirsty-hames added bug Something isn't working accessibility labels Jul 3, 2024
@kirsty-hames kirsty-hames changed the title Issue/561 Fix: heading completion selector added to aria-label (fixes #561) Jul 3, 2024
cahirodoherty-learningpool
cahirodoherty-learningpool approved these changes Jul 5, 2024
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

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

👀

joe-allen-89
joe-allen-89 approved these changes Jul 8, 2024
View reviewed changes
Copy link
Contributor

@joe-allen-89 joe-allen-89 left a comment

Choose a reason for hiding this comment

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

👍

@joe-allen-89 joe-allen-89 merged commit 61d03d4 into master Jul 8, 2024
1 check passed
@joe-allen-89 joe-allen-89 deleted the issue/561 branch July 8, 2024 10:05
github-actions bot pushed a commit that referenced this pull request Jul 8, 2024
@semantic-release-bot
Chore(release): 6.53.2
4f04cc8 
## [6.53.2](v6.53.1...v6.53.2) (2024-07-08)

### Fix

* heading completion selector added to aria-label (fixes #561) (#562) ([61d03d4](61d03d4)), closes [#561](#561) [#562](#562)
@oliverfoster
Copy link
Member

🎉 This PR is included in version 6.53.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

@joe-allen-89 joe-allen-89 joe-allen-89 approved these changes

@cahirodoherty-learningpool cahirodoherty-learningpool cahirodoherty-learningpool approved these changes

@oliverfoster oliverfoster oliverfoster approved these changes

Assignees

@kirsty-hames kirsty-hames

Labels
accessibility bug Something isn't working released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

heading completion aria-label selector is too generic and easily overwritten
4 participants
@kirsty-hames @oliverfoster @cahirodoherty-learningpool @joe-allen-89