Skip to content

Commit

Permalink
Update guidance on alt text for images in rich text
Browse files Browse the repository at this point in the history
This shortcoming was fixed and released in Wagtail 2.13
  • Loading branch information
thibaudcolas committed Jun 11, 2021
1 parent c9a55d8 commit 14b0e80
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/advanced_topics/accessibility_considerations.rst
Expand Up @@ -31,7 +31,7 @@ Ideally, always add an optional “alt text” field wherever an image is used,

- For normal fields, add an alt text field to your image’s panel.
- For StreamField, add an extra field to your image block.
- For rich text – Wagtail already makes it possible to customize alt text for rich text images. Unfortunately, it’s not currently possible to set alt text as an optional field in these situations (see `#6494 <https://github.com/wagtail/wagtail/issues/6494>`_).
- For rich text – Wagtail already makes it possible to customize alt text for rich text images.

When defining the alt text fields, make sure they are optional so editors can choose to not write any alt text for decorative images. Take the time to provide ``help_text`` with appropriate guidance.
For example, linking to `established resources on alt text <https://axesslab.com/alt-texts/>`_.
Expand Down

0 comments on commit 14b0e80

Please sign in to comment.