From 98f21bd9717f74effcbd815bc185939c971e0dfb Mon Sep 17 00:00:00 2001 From: Tobias Berge Date: Mon, 14 Oct 2024 11:48:43 +0200 Subject: [PATCH] Update accessibility documentation (#1512) --- resources/accessibility/storefront/index.md | 80 +++++++++++---------- 1 file changed, 43 insertions(+), 37 deletions(-) diff --git a/resources/accessibility/storefront/index.md b/resources/accessibility/storefront/index.md index 33d4117cf..39acf0832 100644 --- a/resources/accessibility/storefront/index.md +++ b/resources/accessibility/storefront/index.md @@ -97,22 +97,48 @@ If the block `component_list_items` is being extended, the new accessibility cha ## Overview of accessibility issues for iteration 1 -We list our current accessibility issues with their state of implementation in the following ticket: [NEXT-37039](https://issues.shopware.com/issues/NEXT-37039) -This ticket has an up-to-date overview. -Below, we will update the current states with more additional information about the implementation, but this can be lagging a view days behind. +::: info +With accessibility iteration 1 we have addressed the most critical accessibility problems and implemented multiple improvements. +You can find an overview of the accessibility iteration 1 epic in the following ticket: [NEXT-37039](https://issues.shopware.com/issues/NEXT-37039) +::: + +### Continuous efforts to ensure accessibility + +We are continuously testing our core Storefront to meet accessibility requirements. This includes screen reader usage, keyboard-operation or color contrast analyzes. +We are using the [WCAG 2.1 Level AA](https://www.w3.org/TR/WCAG21/) standard and do our best to solve all issues to meet the WCAG 2.1 requirements. ### Overview of released accessibility improvements * Below, you find a list of recent accessibility improvements. The list includes a changelog and the release versions for each improvement. * Enable the feature flag `ACCESSIBILITY_TWEAKS` to activate all breaking accessibility changes. -| Issue key | Topic | Breaking changes | Changelog | Release versions | -|-------------------------------------------------------------|------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| [NEXT-33694](https://issues.shopware.com/issues/NEXT-33694) | Change shipping toggle in OffCanvas cart to button element | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.2.0/changelog/release-6-6-2-0/2024-04-17-change-shipping-costs-toggle-to-button-element.md) | [v6.6.2.0](https://github.com/shopware/shopware/releases/tag/v6.6.2.0) | -| [NEXT-35318](https://issues.shopware.com/issues/NEXT-35318) | Add heading elements for account login page | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.2.0/changelog/release-6-6-2-0/2024-04-15-heading-elements-on-registration-page.md) | [v6.6.2.0](https://github.com/shopware/shopware/releases/tag/v6.6.2.0) | -| [NEXT-34423](https://issues.shopware.com/issues/NEXT-33684) | No empty nav element in top-bar | Yes | [Changelog](https://github.com/shopware/shopware/blob/v6.6.1.0/changelog/release-6-6-1-0/2023-03-05-no-empty-nav.md) | [v6.6.1.0](https://github.com/shopware/shopware/releases/tag/v6.6.1.0) | -| [NEXT-33682](https://issues.shopware.com/issues/NEXT-33682) | Provide distinctive document titles for each page | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.1.0/changelog/release-6-6-1-0/2024-03-12-distinctive-document-titles.md) | [v6.6.1.0](https://github.com/shopware/shopware/releases/tag/v6.6.1.0) | | -| [NEXT-33879](https://issues.shopware.com/issues/NEXT-33879) | A closing mechanism for the navigation | No | [Changelog](https://github.com/shopware/shopware/blob/trunk/changelog/2024-05-03-esc-key-for-nav-flyout-close.md) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| Issue key | Topic | Breaking changes | Changelog | Release versions | +|---------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| [NEXT-33689](https://issues.shopware.com/issues/NEXT-33689) | Missing semantic markup of form address headings | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-13-registration-form-fieldset-improvement.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-33693](https://issues.shopware.com/issues/NEXT-33693) | Product image zoom modal keyboard accessibility | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-08-improve-image-zoom-modal-accessibility.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-33697](https://issues.shopware.com/issues/NEXT-33697) | Focused slides in the carousel are not being moved into the visible area | Yes | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-05-improve-slider-element-accessibility.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-33696](https://issues.shopware.com/issues/NEXT-33696) | Focus jumps to the top of the page after closing a modal | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-01-add-focus-handling-to-storefront.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-26680](https://issues.shopware.com/issues/NEXT-26680) | Ensure that resizing content up to 200% does not cause breaks | Yes | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-13-Improved-storefront-text-scaling.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-26714](https://issues.shopware.com/issues/NEXT-26714) | Language of each Storefront passage or phrase in the content can be programmatically determined | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-05-add-language-to-reviews.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-34090](https://issues.shopware.com/issues/NEXT-34090) | Check Lighthouse Accessibility Score | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2024-08-21-fix-scroll-up-button-accessibility.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-28114](https://issues.shopware.com/issues/NEXT-28114) | Pagination does not have links | Yes | [Changelog](https://github.com/shopware/shopware/blob/v6.6.6.0/changelog/release-6-6-6-0/2023-08-31-pagination-with-links.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.6.0) | +| [NEXT-33682](https://issues.shopware.com/issues/NEXT-33682) | Non-informative document title | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.1.0/changelog/release-6-6-1-0/2024-03-12-distinctive-document-titles.md) | [v6.6.6.0](https://github.com/shopware/shopware/releases/tag/v6.6.1.0) | +| [NEXT-33695](https://issues.shopware.com/issues/NEXT-33695) | The form element quantity selector is not labeled | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.5.0/changelog/release-6-6-5-0/2024-07-15-the-form-element-quantity-selector-is-not-labeled.md) | [v6.6.5.0](https://github.com/shopware/shopware/releases/tag/v6.6.5.0) | +| [NEXT-33675](https://issues.shopware.com/issues/NEXT-33675) | Slider reports confusing status changes to screen readers | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.4.0/changelog/release-6-6-4-0/2024-05-31-remove-unwanted-aria-live-attributes-from-sliders.md) | [v6.6.4.0](https://github.com/shopware/shopware/releases/tag/v6.6.4.0) | +| [NEXT-26682](https://issues.shopware.com/issues/NEXT-26682) | The user needs to be able to close triggered, additional content | No | [Changelog](https://github.com/shopware/shopware/blob/trunk/changelog/release-6-6-3-0/2024-05-03-esc-key-for-nav-flyout-close.md) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| [NEXT-33879](https://issues.shopware.com/issues/NEXT-33879) | Close navigation flyout with escape key | No | [Changelog](https://github.com/shopware/shopware/blob/trunk/changelog/release-6-6-3-0/2024-05-03-esc-key-for-nav-flyout-close.md ) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| [NEXT-33683](https://issues.shopware.com/issues/NEXT-33683) | Improve "Remove Product" button labeling in checkout | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.3.0/changelog/release-6-6-3-0/2024-05-03-improve-line-item-labels-and-alt-texts.md) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| [NEXT-33685](https://issues.shopware.com/issues/NEXT-33685) | Missing alternative text for product images in the shopping cart | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.3.0/changelog/release-6-6-3-0/2024-05-03-improve-line-item-labels-and-alt-texts.md) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| [NEXT-33879](https://issues.shopware.com/issues/NEXT-33879) | A closing mechanism for the navigation | No | [Changelog](https://github.com/shopware/shopware/blob/trunk/changelog/2024-05-03-esc-key-for-nav-flyout-close.md) | [v6.6.3.0](https://github.com/shopware/shopware/releases/tag/v6.6.3.0) | +| [NEXT-33694](https://issues.shopware.com/issues/NEXT-33694) | Change shipping toggle in OffCanvas cart to button element | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.2.0/changelog/release-6-6-2-0/2024-04-17-change-shipping-costs-toggle-to-button-element.md) | [v6.6.2.0](https://github.com/shopware/shopware/releases/tag/v6.6.2.0) | +| [NEXT-35318](https://issues.shopware.com/issues/NEXT-35318) | Add heading elements for account login page | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.2.0/changelog/release-6-6-2-0/2024-04-15-heading-elements-on-registration-page.md) | [v6.6.2.0](https://github.com/shopware/shopware/releases/tag/v6.6.2.0) | +| [NEXT-33682](https://issues.shopware.com/issues/NEXT-33682) | Provide distinctive document titles for each page | No | [Changelog](https://github.com/shopware/shopware/blob/v6.6.1.0/changelog/release-6-6-1-0/2024-03-12-distinctive-document-titles.md) | [v6.6.1.0](https://github.com/shopware/shopware/releases/tag/v6.6.1.0) | +| [NEXT-34423](https://issues.shopware.com/issues/NEXT-33684) | No empty nav element in top-bar | Yes | [Changelog](https://github.com/shopware/shopware/blob/v6.6.1.0/changelog/release-6-6-1-0/2023-03-05-no-empty-nav.md) | [v6.6.1.0](https://github.com/shopware/shopware/releases/tag/v6.6.1.0) | +| [NEXT-26712](https://issues.shopware.com/issues/NEXT-26712) | Update the focus states so that they are clearly visible | No | [Multiple changes](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26712&type=commits) | [Multiple releases](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26712&type=code) | +| [NEXT-26717](https://issues.shopware.com/issues/NEXT-26717) | Increase compatibility of Storefront with future assistance technologies | No | [Multiple changes](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26717&type=commits) | [Multiple releases](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26717&type=code) | +| [NEXT-26705](https://issues.shopware.com/issues/NEXT-26705) | Content functionality operable through keyboard | Yes | [Multiple changes](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26705&type=commits) | [Multiple releases](https://github.com/search?q=repo%3Ashopware%2Fshopware+NEXT-26705&type=code) | +| [NEXT-26707](https://issues.shopware.com/issues/NEXT-26707) | No keyboard traps should occur in the Storefront | - | Verification work without released code changes | - | +| [NEXT-26709](https://issues.shopware.com/issues/NEXT-26709) | Mechanism for the user to pause, stop, or hide moving content | - | Verification work without released code changes | - | ### Overview of known accessibility issues @@ -121,30 +147,10 @@ Please note that only issues that are completely resolved and already released i The list below will include tickets that are already in progress or finished but not released yet. The list also includes checking and evaluation work. You can see the current status via the links to the issue tracker. ::: -| Issue key | Topic | -|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------| -| [NEXT-33675](https://issues.shopware.com/issues/NEXT-33675) | Slider reports confusing status changes to screen readers | -| [NEXT-33683](https://issues.shopware.com/issues/NEXT-33683) | Improve "Remove Product" button labeling in checkout | -| [NEXT-33685](https://issues.shopware.com/issues/NEXT-33685) | Missing alternative text for product images in the shopping cart | -| [NEXT-33689](https://issues.shopware.com/issues/NEXT-33689) | Missing semantic markup of form address headings | -| [NEXT-33693](https://issues.shopware.com/issues/NEXT-33693) | Product image zoom modal keyboard accessibility | -| [NEXT-33695](https://issues.shopware.com/issues/NEXT-33695) | The form element quantity selector is not labeled | -| [NEXT-33696](https://issues.shopware.com/issues/NEXT-33696) | Focus jumps to the top of the page after closing a modal | -| [NEXT-33697](https://issues.shopware.com/issues/NEXT-33697) | Focused slides in the carousel are not being moved into the visible area | -| [NEXT-33879](https://issues.shopware.com/issues/NEXT-33879) | Close navigation flyout with escape key | -| [NEXT-26677](https://issues.shopware.com/issues/NEXT-26677) | Check if all non-text content has text alternative and provide if necessary | -| [NEXT-26679](https://issues.shopware.com/issues/NEXT-26679) | Add text to components that only work with icons to identify their purpose | -| [NEXT-26680](https://issues.shopware.com/issues/NEXT-26680) | Ensure that resizing content up to 200% does not cause breaks | -| [NEXT-26682](https://issues.shopware.com/issues/NEXT-26682) | The user needs to be able to close triggered, additional content | -| [NEXT-26705](https://issues.shopware.com/issues/NEXT-26705) | Content functionality operable through keyboard | -| [NEXT-26707](https://issues.shopware.com/issues/NEXT-26707) | No keyboard traps should occur in the Storefront | -| [NEXT-26709](https://issues.shopware.com/issues/NEXT-26709) | Mechanism for the user to pause, stop, or hide moving content | -| [NEXT-26715](https://issues.shopware.com/issues/NEXT-26715) | Provide error correction suggestions | -| [NEXT-26712](https://issues.shopware.com/issues/NEXT-26712) | Update the focus states so that they are clearly visible | -| [NEXT-26714](https://issues.shopware.com/issues/NEXT-26714) | Language of each Storefront passage or phrase in the content can be programmatically determined | -| [NEXT-26717](https://issues.shopware.com/issues/NEXT-26717) | Increase compatibility of Storefront with future assistance technologies | -| [NEXT-33807](https://issues.shopware.com/issues/NEXT-33807) | Text styles needs to be adjusted (line height, paragraph spacing) | -| [NEXT-34090](https://issues.shopware.com/issues/NEXT-34090) | Check Lighthouse Accessibility Score | -| [NEXT-36116](https://issues.shopware.com/issues/NEXT-36116) | Keyboard/Tabs should work for nav main-navigation-menu | -| [NEXT-21474](https://issues.shopware.com/issues/NEXT-21474) | Pagination does not have links | -| [NEXT-33682](https://issues.shopware.com/issues/NEXT-33682) | Non-informative document title | +| Issue key | Topic | Notes | +|-------------------------------------------------------------|-----------------------------------------------------------------------------|-------------------| +| [NEXT-26679](https://issues.shopware.com/issues/NEXT-26679) | Add text to components that only work with icons to identify their purpose | Unreleased | +| [NEXT-26677](https://issues.shopware.com/issues/NEXT-26677) | Check if all non-text content has text alternative and provide if necessary | Unreleased | +| [NEXT-26715](https://issues.shopware.com/issues/NEXT-26715) | Provide error correction suggestions | Unreleased | +| [NEXT-33807](https://issues.shopware.com/issues/NEXT-33807) | Text styles needs to be adjusted (line height, paragraph spacing) | Unreleased | +| [NEXT-36116](https://issues.shopware.com/issues/NEXT-36116) | Keyboard/Tabs should work for nav main-navigation-menu | Unreleased |