Files
hextra/assets/js/core/menu.js

85 lines
2.8 KiB
JavaScript
Raw Normal View History

// Hamburger menu for mobile navigation
document.addEventListener('DOMContentLoaded', function () {
refactor(css): add prefix to component classes for consistency (#744) * refactor(navbar): add hextra prefix to navbar and hamburger menu classes - Updated CSS class names from `nav-container` to `hextra-nav-container` and `hamburger-menu` to `hextra-hamburger-menu` for improved clarity and consistency across the project. - Adjusted related JavaScript and documentation to reflect the new class names. * refactor(search): update class names for search components - Renamed CSS classes from `search-wrapper`, `search-input`, `active`, `no-result`, `prefix`, `excerpt`, and `match` to `hextra-search-wrapper`, `hextra-search-input`, `hextra-search-active`, `hextra-search-no-result`, `hextra-search-prefix`, `hextra-search-excerpt`, and `hextra-search-match` for improved clarity and consistency. - Updated JavaScript selectors to match the new class names, ensuring functionality remains intact. - Adjusted HTML structure to reflect the new class naming convention. * refactor(search): update search component class names for consistency - Renamed existing search-related CSS classes to include the `hextra` prefix for improved clarity and consistency. - Added optional nested classes for enhanced customization of the search UI, including titles, active states, and result snippets. - Removed outdated breadcrumb section as no specific class is available. * refactor(sidebar): rename sidebar classes for consistency - Updated CSS and JavaScript to replace `sidebar-container` with `hextra-sidebar-container` and `sidebar-active-item` with `hextra-sidebar-active-item` for improved clarity and consistency across the project. - Adjusted related documentation to reflect the new class names. * refactor(language & theme): update class names for consistency - Renamed language switcher and theme toggle classes to include the `hextra` prefix for improved clarity and consistency across the project. - Updated related JavaScript selectors and documentation to reflect the new class names. * refactor(css & html): rename classes for consistency and clarity - Updated various CSS class names to include the `hextra` prefix, enhancing consistency across the project. This includes renaming classes such as `content` to `hextra-content`, `filename` to `hextra-code-filename`, and `steps` to `hextra-steps`. - Adjusted related HTML and JavaScript to reflect the new class names, ensuring functionality and styling remain intact. - Updated documentation to include the new class names for better clarity. * refactor(language): update class names for language options - Renamed the `language-options` class to `hextra-language-options` for consistency with the existing `hextra` prefix convention. - Updated the corresponding HTML to reflect the new class name, ensuring clarity and uniformity across the project. * refactor(css & html): rename classes for consistency and clarity - Renamed CSS classes to include the `hextra` prefix, such as changing `subheading-anchor` to `hextra-subheading-anchor` and `footnotes` to `hextra-footnotes`, enhancing consistency across the project. - Updated related HTML and documentation to reflect the new class names, ensuring clarity and uniformity. * feat(typography): add styling for horizontal lines - Introduced new styles for horizontal lines to enhance visual separation in content. The styles apply margin and border color adjustments, ensuring consistency with the overall design. * feat(blog): add draft release announcement for Hextra v0.10.0 - Created a new markdown file for the draft release announcement of Hextra v0.10.0, including upgrade instructions and author details. - The announcement is currently marked as a draft and may be updated before the official release. * refactor(css & html): rename `hextra-content` class to `content` for consistency - Updated the `hextra-content` class to simply `content` across various HTML files and CSS, enhancing clarity and consistency in the codebase. - Adjusted the `package.json` script for the development server to include the `-F` flag for better functionality. * refactor(typography & markdown): enhance table styling and markdown syntax - Updated CSS for tables to improve styling, including adjustments to margins, borders, and text properties for better readability. - Revised markdown documentation to standardize table formatting and improve clarity, including consistent syntax for headers and lists. - Enhanced examples in the documentation to reflect the updated styling and ensure accurate representation of output. * fix(blog): update text color for improved accessibility - Modified the text color in the blog single layout to enhance readability in dark mode by adding a dark text color class. - Ensured consistency in styling for better user experience across different themes. * docs(blog): update draft release announcement for Hextra v0.10.0 - Revised the "What's New" section to include a TODO placeholder for future updates. - Added a comprehensive migration guide detailing the CSS class prefix changes to enhance consistency and avoid conflicts. - Updated the announcement to reflect the new class naming conventions for various components. * chore: rebuild css
2025-08-13 22:55:38 +08:00
const menu = document.querySelector('.hextra-hamburger-menu');
const sidebarContainer = document.querySelector('.hextra-sidebar-container');
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
const mobileQuery = window.matchMedia('(max-width: 767px)');
function isMenuOpen() {
return menu.querySelector('svg').classList.contains('open');
}
// On mobile, the sidebar is off-screen so hide it from assistive tech
function syncAriaHidden() {
if (mobileQuery.matches) {
sidebarContainer.setAttribute('aria-hidden', isMenuOpen() ? 'false' : 'true');
} else {
sidebarContainer.removeAttribute('aria-hidden');
}
}
// Set initial state
syncAriaHidden();
mobileQuery.addEventListener('change', syncAriaHidden);
function toggleMenu(options = {}) {
const { focusOnOpen = true } = options;
// Toggle the hamburger menu
menu.querySelector('svg').classList.toggle('open');
// When the menu is open, we want to show the navigation sidebar
chore: migrate to Tailwind CSS v4.0 (#632) * chore: migrate PostCSS configuration to v4 * chore: update dependencies in package.json and package-lock.json - Bump versions for autoprefixer, postcss, postcss-cli, prettier, and tailwindcss. - Remove unused dependencies to streamline the project. * chore: add @tailwindcss/postcss and update package-lock.json * fix: update import paths in CSS files for consistency * fix: change prefix from `hx-` to `hx:` * chore: migrate primary color theme variables to CSS * fix: remove unnecessary text decoration property from anchor styles in typography CSS * fix: update CSS styles for improved consistency and clarity across components * chore: clean up package.json and package-lock.json, remove unused dependencies, and update CSS imports for better organization * fix: bulk replace prefix `hx-` with `hx:` * fix: update tailwind css prefix * fix: styling consistent issues - steps counter fix in v4 - removed tailwind.css - update hr border colors - fix button cursor in v4 - fix border colors in various places * fix: update class prefixes for consistency in menu and sidebar components * fix: refine CSS classes and transitions for navbar and sidebar components - Updated hamburger menu styles for improved animation and structure. - Adjusted sidebar transition duration for smoother effects. - Standardized class prefixes for consistency across components. * fix: update border color in hero badge component for improved styling consistency * fix: update tab button cursor style for improved user interaction * chore: recompile css * fix: dark mode color not applied for before / after elements * fix: docs navigation * chore: recompile CSS * chore: update Tailwind CSS and PostCSS dependencies to version 4.0.17, recompile CSS, and add safelist * fix: typo in class name and add back decoration-from-font for typography a tags * fix: update class syntax for Tailwind CSS compatibility in mermaid code block
2025-03-29 12:51:42 +00:00
sidebarContainer.classList.toggle('hx:max-md:[transform:translate3d(0,-100%,0)]');
sidebarContainer.classList.toggle('hx:max-md:[transform:translate3d(0,0,0)]');
// When the menu is open, we want to prevent the body from scrolling
chore: migrate to Tailwind CSS v4.0 (#632) * chore: migrate PostCSS configuration to v4 * chore: update dependencies in package.json and package-lock.json - Bump versions for autoprefixer, postcss, postcss-cli, prettier, and tailwindcss. - Remove unused dependencies to streamline the project. * chore: add @tailwindcss/postcss and update package-lock.json * fix: update import paths in CSS files for consistency * fix: change prefix from `hx-` to `hx:` * chore: migrate primary color theme variables to CSS * fix: remove unnecessary text decoration property from anchor styles in typography CSS * fix: update CSS styles for improved consistency and clarity across components * chore: clean up package.json and package-lock.json, remove unused dependencies, and update CSS imports for better organization * fix: bulk replace prefix `hx-` with `hx:` * fix: update tailwind css prefix * fix: styling consistent issues - steps counter fix in v4 - removed tailwind.css - update hr border colors - fix button cursor in v4 - fix border colors in various places * fix: update class prefixes for consistency in menu and sidebar components * fix: refine CSS classes and transitions for navbar and sidebar components - Updated hamburger menu styles for improved animation and structure. - Adjusted sidebar transition duration for smoother effects. - Standardized class prefixes for consistency across components. * fix: update border color in hero badge component for improved styling consistency * fix: update tab button cursor style for improved user interaction * chore: recompile css * fix: dark mode color not applied for before / after elements * fix: docs navigation * chore: recompile CSS * chore: update Tailwind CSS and PostCSS dependencies to version 4.0.17, recompile CSS, and add safelist * fix: typo in class name and add back decoration-from-font for typography a tags * fix: update class syntax for Tailwind CSS compatibility in mermaid code block
2025-03-29 12:51:42 +00:00
document.body.classList.toggle('hx:overflow-hidden');
document.body.classList.toggle('hx:md:overflow-auto');
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
// Sync aria-expanded and aria-hidden
const isOpen = isMenuOpen();
menu.setAttribute('aria-expanded', isOpen ? 'true' : 'false');
syncAriaHidden();
// Move focus into sidebar when opening, restore when closing
if (isOpen) {
if (focusOnOpen) {
const firstFocusable = sidebarContainer.querySelector('a, button, input, [tabindex="0"]');
if (firstFocusable) firstFocusable.focus();
}
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
} else {
menu.focus();
}
}
menu.addEventListener('click', (e) => {
e.preventDefault();
// Pointer-initiated clicks on mobile should not force focus into the search input,
// which opens the software keyboard immediately.
toggleMenu({ focusOnOpen: e.detail === 0 });
});
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
// Close menu on Escape key (mobile only)
document.addEventListener('keydown', (e) => {
if (e.key === 'Escape' && mobileQuery.matches && isMenuOpen()) {
toggleMenu();
}
});
// Select all anchor tags in the sidebar container
const sidebarLinks = sidebarContainer.querySelectorAll('a');
// Add click event listener to each anchor tag
sidebarLinks.forEach(link => {
link.addEventListener('click', (e) => {
// Check if the href attribute contains a hash symbol (links to a heading)
if (link.getAttribute('href') && link.getAttribute('href').startsWith('#')) {
// Only dismiss overlay on mobile view
if (window.innerWidth < 768) {
toggleMenu();
}
}
});
});
});