¶ Accessibility Widget
This documentation always describes the latest published version.
¶ Overview
A floating accessibility widget for Sylius 2 shops, built with the German Barrierefreiheitsstärkungsgesetz (BFSG) and WCAG 2.1 AA in mind. Visitors adjust font size, contrast, colour-vision filters, a blue light filter and reduced motion themselves, plus a skip link for keyboard users.
Cookie-free: a visitor's choices live in the browser's
localStorageonly. No cookie is set, so the widget needs no entry in a consent tool.
This plugin alone does not make a shop BFSG compliant. It helps in a few areas (skip link for 2.4.1; contrast, text size and reduced motion for 1.4.3, 1.4.4, 2.3.3) but cannot fix a theme's own contrast, markup or content. A real audit of the whole shop is still required.
¶ Documentation
| Page | Content |
|---|---|
| Installation and Operation | Installation, update, uninstall |
| Configuration | Settings per channel, admin grid, practical examples |
| Storefront Integration | Twig hooks, skip link target, theming, behaviour in detail, theme compatibility |
| Shop API / Headless | Endpoint, request/response, error format |
| Extending | Public interfaces, template override, internal classes |
| Troubleshooting and FAQ | Common problems, known limitations, frequently asked questions |
| Technical Details | Flow, plugin structure, entity |
¶ Features
| Feature | Description |
|---|---|
| Five tools | Font size (small/normal/large), contrast (normal/high/inverted), colour-vision filters (protanopia, deuteranopia, tritanopia), blue light filter, reduced motion |
| Skip link | A keyboard "skip to main content" link at the very top of the page |
| Cookie-free | Settings live in localStorage only, no cookie, no consent entry needed |
| Per channel | Widget on/off, position and offered tools separately for every channel |
| Dual-mode | The Twig storefront renders the widget; the same per-channel settings are readable through the Shop API |
| No build step | Plain CSS/JavaScript, installed with assets:install |
¶ Requirements
| Requirement | Version | Notes |
|---|---|---|
| PHP | ^8.3 | |
| Sylius | ^2.2 | tested on 2.2 and 2.3 |
| Symfony | ^7.4 | |
| Database | MySQL 8 or MariaDB | The migration is written in MySQL syntax and deliberately aborts on any other platform; PostgreSQL is not supported |
¶ License
Commercial license: one license covers one Sylius installation (all channels plus its development and staging environments). Redistribution is not allowed, updates are included for 12 months from purchase. Versions 1.0.0 and 1.1.0 were published under the MIT license; that grant stays valid for those versions.
¶ Support
For questions about the license, technical questions or bugs, reach me at support@markus-michalski.net.