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.

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

Update a11y.ts #9567

Merged
merged 5 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
5 changes: 5 additions & 0 deletions .changeset/orange-trainers-learn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"astro": minor
---

Improve a11y-missing-content rule for audit feature of dev-overlay
OliverSpeir marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -352,13 +352,45 @@ export const a11y: AuditRuleWithSelector[] = [
},
{
code: 'a11y-missing-content',
title: 'Missing content on element important for accessibility',
message: 'Headings and anchors must have content to be accessible.',
title: 'Missing content',
message:
'Headings and anchors must have an accessible name, which can come from: inner text, aria-label, aria-labelledby, an img with alt property, or an svg with a title.',
OliverSpeir marked this conversation as resolved.
Show resolved Hide resolved
selector: a11y_required_content.join(','),
match(element: HTMLElement) {
// innerText is used to ignore hidden text
const innerText = element.innerText.trim();
if (innerText === '') return true;
if (innerText !== '') return false;

// Check for aria-label
const ariaLabel = element.getAttribute('aria-label')?.trim();
if (ariaLabel && ariaLabel !== '') return false;

// Check for valid aria-labelledby
const ariaLabelledby = element.getAttribute('aria-labelledby')?.trim();
if (ariaLabelledby) {
const ids = ariaLabelledby.split(' ');
for (const id of ids) {
const referencedElement = document.getElementById(id);
if (referencedElement && referencedElement.innerText.trim() !== '') return false;
}
}

// Check for <img> with valid alt attribute
const imgElements = element.querySelectorAll('img');
OliverSpeir marked this conversation as resolved.
Show resolved Hide resolved
for (const img of imgElements) {
const altAttribute = img.getAttribute('alt');
if (altAttribute && altAttribute.trim() !== '') return false;
}

// Check for <svg> with valid title
const svgElements = element.querySelectorAll('svg');
OliverSpeir marked this conversation as resolved.
Show resolved Hide resolved
for (const svg of svgElements) {
const titleText = svg.querySelector('title');
if (titleText && titleText.textContent && titleText.textContent.trim() !== '') return false;
}

// If all checks fail, return true indicating missing content
return true;
},
},
{
Expand Down
Loading