✅ Accessibility content checks for Wagtail websites. Try it out on our static demo page!
As of Wagtail 4.2, Wagtail has built-in accessibility checks. However those checks are only based on automation – and are only set up for scenarios where the checks can always provide correct results, rather than leaving room for interpretation.
In contrast, wagtail-accessibility focuses on providing tools to support CMS users with their manual testing:
It also integrates a "screen reader wand", for CMS users to preview how a given element would appear for a screen reader.
For more details about the future of accessibility checks in Wagtail, read Looking for sponsorship – Accessibility checks for site administrators.
Install using pip:
pip install wagtail-accessibility
Then add wagtailaccessibility
to your INSTALLED_APPS
. It works with Wagtail 5.2 and upwards.
This plugin, when added to your template, will add tota11y to all page previews. Tota11y is an accessibility visualization toolkit.
To use it, simply include this in your template, and from now on all page previews will include it.
{% load wagtailaccessibility_tags %}
{% tota11y %}
This plugin also contains a jinja2 implementation, to use it, include the following in your config.
{
'BACKEND': 'django.template.backends.jinja2.Jinja2',
'OPTIONS': {
'extensions': [
# […]
'wagtailaccessibility.jinja2tags.tota11y',
],
},
}
The template tag can then be used like so:
{{ tota11y() }}
This section is for maintainers of this package.
CHANGELOG.md
is up to date.
setup.py
and update it if necessary. Follow semantic versioning.setup.py
to the next version, and add a new section to CHANGELOG.md
for the next release (with a date of "unreleased")