Documentation request: accessibility considerations for Wagtail sites
See original GitHub issueReviewing the issues currently marked label:Accessibility, there are now quite a few that are about the accessibility of websites built with Wagtail, rather than the accessibility of the Wagtail admin UI. Wagtail generally tries to be un-opinionated about front-end markup, but there are areas where it has a lot of opinions, and I think it would be valuable to have a one-stop-shop document highlighting “things to consider for Wagtail websites to be accessible”.
I see this as a single “Accessibility considerations for Wagtail websites” page, but it could also be split into separate parts of the documentation – feedback welcome.
Here is what this page could contain:
- Images
- alt text. Where it comes from in Wagtail (the
title
field by default). How to change that.- With guidance on when you need alt text
- https://github.com/wagtail/rfcs/pull/51
- Images in rich text can override the alt text. Some implementations of the image chooser may allow that too. Document this.
- Images in rich text should be allowed to have empty alt text
- StreamField: https://github.com/wagtail/rfcs/pull/51
- alt text. Where it comes from in Wagtail (the
- Rich text
- StreamField
- Empty headings
- TableBlock
- #5989
- How to make the “caption” field mandatory if appropriate
- Embeds
- Links
- Ways to prevent “read more” or “click here” links (or how to add a custom
aria-label
for those)- Note – some times it’s appropriate to use short link text and this should be supported too.
- Ways to prevent
href="None"
issues when pages are unpublished or deleted
- Ways to prevent “read more” or “click here” links (or how to add a custom
Additionally, we could also use this page to make recommendations for accessibility resources and testing tools geared towards Wagtail websites.
I’ll update this list as I stumble upon more things like this.
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (5 by maintainers)
Top GitHub Comments
Done - added https://github.com/wagtail/wagtail/issues/6108
I have created a project board for everything on this list that could potentially be fixed in Wagtail (they all have their own separate issues or RFCs): https://github.com/wagtail/wagtail/projects/10.