wagtail/docs/advanced_topics/accessibility_considerations.md

Accessibility considerations

Accessibility for CMS-driven websites is a matter of modeling content appropriately, creating accessible templates, and authoring accessible content with readability and accessibility guidelines in mind.

Wagtail generally puts developers in control of content modeling and front-end markup, but there are a few areas to be aware of nonetheless, and ways to help authors be aware of readability best practices. Note there is much more to building accessible websites than we cover here – see our list of accessibility resources for more information.

---
local:
depth: 1
---

(content_modeling)=

Content modeling

As part of defining your site’s models, here are areas to pay special attention to:

Alt text for images

The default behavior for Wagtail images is to use the title field as the alt text (#4945). This is inappropriate, as it’s not communicated in the CMS interface, and the image upload form uses the image’s filename as the title by default.

Ideally, always add an optional “alt text” field wherever an image is used, alongside the image field:

• 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.

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.

Should I add an alt text field on the Image model for my site?

It’s better than nothing to have a dedicated alt field on the Image model ([#5789](https://github.com/wagtail/wagtail/pull/5789)), and may be appropriate for some websites, but we recommend to have it inline with the content because ideally alt text should be written for the context the image is used in:

- If the alt text’s content is already part of the rest of the page, ideally the image should not repeat the same content.
- Ideally, the alt text should be written based on the context the image is displayed in.
- An image might be decorative in some cases but not in others. For example, thumbnails in page listings can often be considered decorative.

See RFC 51: Contextual alt text for a long-term solution to this problem.

Embeds title

Missing embed titles are common failures in accessibility audits of Wagtail websites. In some cases, Wagtail embeds’ iframe doesn’t have a title attribute set. This is generally a problem with OEmbed providers like YouTube (#5982). This is very problematic for screen reader users, who rely on the title to understand what the embed is, and whether to interact with it or not.

If your website relies on embeds that have missing titles, make sure to either:

• Add the OEmbed title field as a title on the iframe.
• Add a custom mandatory Title field to your embeds, and add it as the iframe’s title.

Available heading levels

Wagtail makes it very easy for developers to control which heading levels should be available for any given content, via rich text features or custom StreamField blocks. In both cases, take the time to restrict what heading levels are available so the pages’ document outline is more likely to be logical and sequential. Consider using the following restrictions:

• Disallow h1 in rich text. There should only be one h1 tag per page, which generally maps to the page’s title.
• Limit heading levels to h2 for the main content of a page. Add h3 only if deemed necessary. Avoid other levels as a general rule.
• For content that is displayed in a specific section of the page, limit heading levels to those directly below the section’s main heading.

If managing headings via StreamField, make sure to apply the same restrictions there.

Bold and italic formatting in rich text

By default, Wagtail stores its bold formatting as a b tag, and italic as i (#4665). While those tags don’t necessarily always have correct semantics (strong and em are more ubiquitous), there isn’t much consequence for screen reader users, as by default screen readers do not announce content differently based on emphasis.

If this is a concern to you, you can change which tags are used when saving content with rich text format converters. In the future, rich text rewrite handlers should also support this being done without altering the storage format (#4223).

TableBlock

The TableBlock default implementation makes it too easy for end-users to miss they need either row or column headers (#5989). Make sure to always have either row headers or column headers set. Always add a Caption, so screen reader users navigating the site’s tables know where they are.

(accessibility_in_templates)=

Accessibility in templates

Here are common gotchas to be aware of to make the site’s templates as accessible as possible.

Alt text in templates

See the content modelling section above. Additionally, make sure to customise images’ alt text, either setting it to the relevant field, or to an empty string for decorative images, or images where the alt text would be a repeat of other content. Even when your images have alt text coming directly from the image model, you still need to decide whether there should be alt text for the particular context the image is used in. For example, avoid alt text in listings where the alt text just repeats the listing items’ title.

Empty heading tags

In both rich text and custom StreamField blocks, it’s sometimes easy for editors to create a heading block but not add any content to it. If this is a problem for your site,

• Add validation rules to those fields, making sure the page can’t be saved with the empty headings, for example by using the StreamField CharBlock which is required by default.
• Consider adding similar validation rules for rich text fields (#6526).

Additionally, you can hide empty heading blocks with CSS:

h1:empty,
h2:empty,
h3:empty,
h4:empty,
h5:empty,
h6:empty {
    display: none;
}

Forms

The Form builder uses Django’s forms API. Here are considerations specific to forms in templates:

• Avoid rendering helpers such as as_table, as_ul, as_p, which can make forms harder to navigate for screen reader users or cause HTML validation issues (see Django ticket #32339).
• Make sure to visually distinguish required and optional fields.
• Take the time to group related fields together in fieldset, with an appropriate legend, in particular for radios and checkboxes (see Django ticket #32338).
• If relevant, use the appropriate autocomplete and autocapitalize attributes.
• For Date and Datetime fields, make sure to display the expected format or an example value (see Django ticket #32340). Or use input type="date".
• For Number fields, consider whether input type="number" really is appropriate, or whether there may be better alternatives such as inputmode.

Make sure to test your forms’ implementation with assistive technologies, and review official W3C guidance on accessible forms development for further information.

(authoring_accessible_content)=

Authoring accessible content

A number of built-in tools and additional resources are available to help create accessible content.

Built-in accessibility checker

Wagtail includes an accessibility checker built into the user bar and editing views supporting previews. The checker can help authors create more accessible websites following best practices and accessibility standards like WCAG.

The checker is based on the Axe testing engine and scans the loaded page for errors.

By default, the checker includes the following rules to find common accessibility issues in authored content:

• button-name: <button> elements must always have a text label.
• empty-heading: This rule checks for headings with no text content. Empty headings are confusing to screen readers users and should be avoided.
• empty-table-header: Table header text should not be empty
• frame-title: <iframe> elements must always have a text label.
• heading-order: This rule checks for incorrect heading order. Headings should be ordered in a logical and consistent manner, with the main heading (h1) followed by subheadings (h2, h3, etc.).
• input-button-name: <input> button elements must always have a text label.
• link-name: <a> link elements must always have a text label.
• p-as-heading: This rule checks for paragraphs that are styled as headings. Paragraphs should not be styled as headings, as they don’t help users who rely on headings to navigate content.

To customize how the checker is run (such as what rules to test), you can define a custom subclass of {class}~wagtail.admin.userbar.AccessibilityItem and override the attributes to your liking. Then, swap the instance of the default AccessibilityItem with an instance of your custom class via the construct_wagtail_userbar hook.

The following is the reference documentation for the AccessibilityItem class:

.. autoclass:: wagtail.admin.userbar.AccessibilityItem

    .. autoattribute:: axe_include
    .. autoattribute:: axe_exclude
    .. autoattribute:: axe_run_only
       :no-value:
    .. autoattribute:: axe_rules
    .. autoattribute:: axe_messages
       :no-value:

    The above attributes can also be overridden via the following methods to allow per-request customization.
    When overriding these methods, be mindful of the mutability of the class attributes above.
    To avoid unexpected behavior, you should always return a new object instead of modifying the attributes
    directly in the methods.

    .. method:: get_axe_include(request)
    .. method:: get_axe_exclude(request)
    .. method:: get_axe_run_only(request)
    .. method:: get_axe_rules(request)
    .. method:: get_axe_messages(request)

    For more advanced customization, you can also override the following methods:

    .. automethod:: get_axe_context
    .. automethod:: get_axe_options

Here is an example of a custom AccessibilityItem subclass that enables more rules:

from wagtail.admin.userbar import AccessibilityItem


class CustomAccessibilityItem(AccessibilityItem):
    # Run all rules with these tags
    axe_run_only = [
        "wcag2a",
        "wcag2aa",
        "wcag2aaa",
        "wcag21a",
        "wcag21aa",
        "wcag22aa",
        "best-practice",
    ]
    # Except for the color-contrast-enhanced rule
    axe_rules = {
        "color-contrast-enhanced": {"enabled": False},
    }

    def get_axe_rules(self, request):
        # Do not disable any rules if the user is a superuser
        if request.user.is_superuser:
            return {}
        return self.axe_rules


@hooks.register('construct_wagtail_userbar')
def replace_userbar_accessibility_item(request, items):
    items[:] = [CustomAccessibilityItem() if isinstance(item, AccessibilityItem) else item for item in items]

wagtail-accessibility

wagtail-accessibility is a third-party package which adds tota11y to Wagtail previews. This makes it easy for authors to run basic accessibility checks – validating the page’s heading outline, or link text.

help_text and HelpPanel

Occasional Wagtail users may not be aware of your site’s content guidelines, or best practices of writing for the web. Use fields’ help_text and HelpPanel (see Panel types).

Readability

Readability is fundamental to accessibility. One of the ways to improve text content is to have a clear target for reading level / reading age, which can be assessed with wagtail-readinglevel as a score displayed in rich text fields.

(accessibility_resources)=

Accessibility resources

We focus on considerations specific to Wagtail websites, but there is much more to accessibility. Here are valuable resources to learn more, for developers but also designers and authors:

• W3C Accessibility Fundamentals
• The A11Y Project
• US GSA – Accessibility for Teams
• UK GDS – Dos and don’ts on designing for accessibility
• Accessibility Developer Guide