Skip to content

Fix: Add aria-label to Vimeo iframe for screen readers (fixes #55) #56

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

Open
swashbuck wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix: Add aria-label to Vimeo iframe for screen readers (fixes #55) #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fd3eae
Fix: add aria-label to iframe for screen readers (fixes #55)
swashbuck Jun 4, 2026
88872c5
Fix: reference visible title heading via aria-labelledby (#55)
swashbuck Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion js/adapt-vimeo.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,33 @@ class Vimeo extends ComponentView {
setupPlayer() {
this.vimeoView = this.addSubview(VimeoView, this.model.get('_media'));

this.listenToOnce(this.vimeoView, 'ready', this.setReadyStatus);
this.listenToOnce(this.vimeoView, 'ready', this.onVimeoViewReady);
}

onVimeoViewReady() {
this.setIframeAccessibleName();
this.setReadyStatus();
}

/**
* Give the player iframe an author-controlled, localisable accessible name.
* The Vimeo library otherwise only sets a `title` from the video's own
* Vimeo title, which authors cannot control or localise.
*
* When a displayTitle is set it renders as a visible component heading, so
* the iframe references that heading via aria-labelledby rather than
* duplicating the string. Otherwise the non-visible title field is used
* directly as an aria-label. Mirrors adapt-youtube#48.
*/
setIframeAccessibleName() {
const iframe = this.vimeoView.player?.element;
if (!iframe) return;
if (this.model.get('displayTitle')) {
iframe.setAttribute('aria-labelledby', `${this.model.get('_id')}-heading`);
return;
}
const title = this.model.get('title');
if (title) iframe.setAttribute('aria-label', title);
}

setupEventListeners() {
Expand Down