Files
hextra/assets/js/core/page-context-menu.js
Xin 88aa6098f0 refactor(a11y): comprehensive WCAG 2.2 AA accessibility improvements (#924)
* refactor(a11y): comprehensive WCAG 2.2 AA accessibility improvements

Add skip-to-content link, landmark regions, ARIA attributes, keyboard
navigation, focus styles, reduced-motion support, and i18n keys across
all layouts, partials, shortcodes, and JS components.

- Add skip nav link in baseof.html and id="content" on all <main> tags
- Fix 404 page lang/dir attributes and add <main> landmark
- Add aria-label to banner close, PDF iframe, search input/results
- Remove aria-hidden from back-to-top button
- Add aria-hidden to decorative external link icon
- Add role="tablist" to tabs, aria-expanded to filetree/dropdowns
- Wrap mermaid diagrams in role="img", asciinema in role="region"
- Change theme toggle <p> items to <button role="menuitem"> with
  full keyboard navigation (Arrow/Home/End/Escape)
- Add arrow-key keyboard navigation to tabs component
- Separate sidebar collapsible button from link for independent
  keyboard access with aria-expanded sync
- Sync aria-expanded on all dropdown toggles (theme, lang, navbar,
  hamburger, page context menu)
- Add aria-live search status announcements
- Add 13 new i18n keys, replace hardcoded aria-label strings
- Add prefers-reduced-motion CSS override and focus-visible base styles
- Add aria-label swap on code copy ("Copied!" feedback for AT)
- Add aria-current to active TOC links
- Wrap filetree in <ul> container for proper list semantics
- Add unique aria-label to blog "Read more" links
- Document accessibility guidelines in AGENTS.md

* feat(a11y): enhance focus styles and accessibility for various components

- Add focus-visible styles to badges, buttons, and links for improved keyboard navigation.
- Update breadcrumb, sidebar, and TOC components to include focus-visible outlines.
- Introduce new classes for focus states in the badge and tabs shortcodes.
- Ensure consistent focus styles across all interactive elements to meet WCAG 2.2 AA standards.

* feat(a11y): implement new focus-visible utilities and enhance accessibility styles

- Introduce new utility classes for focus-visible states to improve keyboard navigation.
- Update various components including badges, buttons, and search inputs to utilize new focus-visible styles.
- Refactor existing focus styles to ensure consistency and compliance with accessibility standards.
- Enhance breadcrumb, sidebar, and TOC components with updated focus-visible classes for better user experience.

* chore: add .gitattributes to collapse generated files in PR diffs

* fix: enhance accessibility and improve documentation

- Added alt attributes to images in multiple language documentation files for better accessibility.
- Updated the navbar title partial to remove unnecessary title attribute.
- Improved search input accessibility by adding autocomplete="off".
- Enhanced search partials in both navbar and sidebar with location context.
- Updated SVG icons in various components to include aria-hidden and focusable attributes for improved accessibility compliance.

* fix: improve giscus theme toggle functionality

- Updated the theme toggle options selector to use a data attribute for better specificity.
- Modified the event listener to use a setTimeout for the theme update, ensuring smoother transitions when the theme switcher is clicked.

* fix: resolve axe-core WCAG AA violations across docs pages

Add aria-labels to Hugo task list checkboxes, fix asciinema player
timer accessible names, make Jupyter output cells keyboard-focusable,
and add missing heading hierarchy in shortcodes docs for fa/ja/zh-cn.

* feat: integrate accessibility testing with Playwright and enhance CI workflow

- Added Playwright configuration for accessibility testing.
- Implemented accessibility tests using axe-core for all English pages.
- Created a GitHub Actions workflow to automate accessibility tests on pull requests.
- Updated package dependencies to include @axe-core/playwright and @playwright/test.
- Enhanced sidebar component with data attributes for improved accessibility styling.

* fix: update base URL and improve accessibility labels across multiple languages

- Changed the base URL in Playwright configuration and CI workflow from localhost:3000 to localhost:1313.
- Added accessibility labels for screen readers in various language files, enhancing user experience for visually impaired users.
- Updated the Asciinema script to dynamically set the playback time label for better accessibility compliance.

* refactor: reorganize accessibility tests and update test directory structure

- Moved accessibility tests from the e2e directory to a new tests directory for better organization.
- Updated the test directory path in Playwright configuration.
- Refactored the accessibility test implementation to improve code clarity and maintainability.

* chore: update .gitignore to include Playwright test output directories

- Added entries for 'playwright-report/' and 'test-results/' to the .gitignore file to prevent cluttering the repository with test artifacts.

* refactor: enhance accessibility and improve focus styles across components

- Removed unused utility for focus visibility in CSS and consolidated focus-visible styles for better maintainability.
- Updated various components to use `role` attributes for improved accessibility, including menu items and buttons.
- Enhanced theme toggle and language switch components with appropriate ARIA roles and attributes for better screen reader support.
- Improved the handling of focus states in the navigation and context menus to ensure a consistent user experience.

* chore: update dependencies and enhance accessibility features

- Updated the 'serve' package version in package.json and package-lock.json for improved performance.
- Removed unused 'xml2js' dependency to streamline the project.
- Enhanced the Playwright configuration to better manage the web server setup for testing.
- Improved accessibility in the language switcher and navigation menu by refining focus management and keyboard interactions.
- Updated the back-to-top button to manage tabindex for better accessibility compliance.

* feat: enhance mobile menu accessibility and keyboard interactions

- Added ARIA attributes to manage visibility of the sidebar on mobile devices.
- Implemented focus management for the sidebar when the menu is toggled.
- Introduced keyboard support to close the menu with the Escape key.
- Improved overall accessibility for the hamburger menu and sidebar interactions.

* fix: refine mobile menu keyboard interaction and enhance navbar accessibility

- Updated the Escape key functionality to close the menu only on mobile devices.
- Added a new ARIA attribute to the hamburger menu button for improved accessibility.
2026-02-14 20:06:35 +00:00

173 lines
6.0 KiB
JavaScript

document.addEventListener('DOMContentLoaded', () => {
// Pre-fetch markdown content for all copy buttons to avoid Safari NotAllowedError
// Safari requires clipboard writes to happen synchronously within user gesture
const copyButtons = document.querySelectorAll('.hextra-page-context-menu-copy');
const contentCache = new Map();
// Pre-fetch content for each button on page load
copyButtons.forEach(button => {
const url = button.dataset.url;
if (url) {
fetch(url)
.then(response => {
if (response.ok) return response.text();
throw new Error('Failed to fetch');
})
.then(markdown => contentCache.set(url, markdown))
.catch(error => console.error('Failed to pre-fetch markdown:', error));
}
});
// Initialize copy buttons with synchronous clipboard access
copyButtons.forEach(button => {
button.addEventListener('click', () => {
const url = button.dataset.url;
const markdown = contentCache.get(url);
if (markdown) {
// Synchronous clipboard write initiation - works in Safari
navigator.clipboard.writeText(markdown)
.then(() => {
button.classList.add('copied');
setTimeout(() => button.classList.remove('copied'), 1000);
})
.catch(error => console.error('Failed to copy markdown:', error));
} else {
// Fallback: fetch and copy (may fail in Safari if content not pre-fetched)
fetch(url)
.then(response => {
if (!response.ok) throw new Error('Failed to fetch');
return response.text();
})
.then(text => {
contentCache.set(url, text);
return navigator.clipboard.writeText(text);
})
.then(() => {
button.classList.add('copied');
setTimeout(() => button.classList.remove('copied'), 1000);
})
.catch(error => console.error('Failed to copy markdown:', error));
}
});
});
// Initialize dropdown toggles
const dropdownToggles = document.querySelectorAll('.hextra-page-context-menu-toggle');
dropdownToggles.forEach(toggle => {
const container = toggle.closest('.hextra-page-context-menu');
const menu = container.querySelector('.hextra-page-context-menu-dropdown');
const chevron = toggle.querySelector('[data-chevron]');
toggle.addEventListener('click', (e) => {
e.stopPropagation();
const isOpen = toggle.dataset.state === 'open';
// Close all other dropdowns first
dropdownToggles.forEach(t => {
if (t !== toggle) {
t.dataset.state = 'closed';
t.setAttribute('aria-expanded', 'false');
const otherContainer = t.closest('.hextra-page-context-menu');
const otherMenu = otherContainer.querySelector('.hextra-page-context-menu-dropdown');
const otherChevron = t.querySelector('[data-chevron]');
otherMenu.classList.add('hx:hidden');
if (otherChevron) {
otherChevron.style.transform = '';
}
}
});
// Toggle current
toggle.dataset.state = isOpen ? 'closed' : 'open';
toggle.setAttribute('aria-expanded', isOpen ? 'false' : 'true');
menu.classList.toggle('hx:hidden', isOpen);
// Rotate chevron icon
if (chevron) {
chevron.style.transform = isOpen ? '' : 'rotate(180deg)';
}
});
});
// Close dropdown when clicking outside
document.addEventListener('click', (e) => {
// Check if click is outside any dropdown container
const isOutside = !e.target.closest('.hextra-page-context-menu');
if (isOutside) {
dropdownToggles.forEach(toggle => {
toggle.dataset.state = 'closed';
toggle.setAttribute('aria-expanded', 'false');
const container = toggle.closest('.hextra-page-context-menu');
const menu = container.querySelector('.hextra-page-context-menu-dropdown');
const chevron = toggle.querySelector('[data-chevron]');
menu.classList.add('hx:hidden');
if (chevron) {
chevron.style.transform = '';
}
});
}
});
// Close dropdown on Escape key and return focus to toggle
document.addEventListener('keydown', (e) => {
if (e.key === 'Escape') {
dropdownToggles.forEach(toggle => {
if (toggle.dataset.state === 'open') {
const container = toggle.closest('.hextra-page-context-menu');
closeDropdown(container);
toggle.focus();
}
});
}
});
// Helper to close dropdown
const closeDropdown = (container) => {
if (!container) return;
const toggle = container.querySelector('.hextra-page-context-menu-toggle');
const menu = container.querySelector('.hextra-page-context-menu-dropdown');
if (!toggle || !menu) return;
const chevron = toggle.querySelector('[data-chevron]');
toggle.dataset.state = 'closed';
toggle.setAttribute('aria-expanded', 'false');
menu.classList.add('hx:hidden');
if (chevron) {
chevron.style.transform = '';
}
};
// Handle dropdown menu copy action
document.querySelectorAll('.hextra-page-context-menu-dropdown button[data-action="copy"]').forEach(btn => {
btn.addEventListener('click', async (e) => {
e.stopPropagation();
const container = btn.closest('.hextra-page-context-menu');
if (!container) return;
const copyBtn = container.querySelector('.hextra-page-context-menu-copy');
if (!copyBtn) return;
closeDropdown(container);
copyBtn.click();
});
});
// Handle dropdown menu view action
document.querySelectorAll('.hextra-page-context-menu-dropdown button[data-action="view"]').forEach(btn => {
btn.addEventListener('click', (e) => {
e.stopPropagation();
const container = btn.closest('.hextra-page-context-menu');
if (!container) return;
const url = btn.dataset.url;
if (!url) return;
closeDropdown(container);
window.open(url, '_blank', 'noopener,noreferrer');
});
});
});