When entering edit mode, without visual cues, the changed state of the page is not discernable. For example, the page is rendered in a "mode" that requires a user to save or exit the mode. The user is no longer consuming content, they are editing content. Users who navigate content aurally require information about the state of the page presented through sound rather than visuals.

Proposed resolution

Introduce an aria live region to the Edit module HTML output and a set of methods that allow updates to this region to be posted as the Edit module changes the state of the page.

Updates that should be noted

  • Edit mode is active. The tab index has been altered.
  • Controls to save and publish changes, as well as exit edit mode, are available.
  • There are N number of editable fields on the page.
  • A new editable field has been added to the page.
  • The page content has been changed.
  • Changes have been abandoned.

Aria live region documentation

Remaining tasks

Propose an initial patch.

User interface changes

For aural UI users, they will have additional information about changes to the page's state.

API changes


#2 aria-messaging-1851092-2.patch8.23 KBjessebeach


Wim Leers’s picture

Component: Code » Accessibility
jessebeach’s picture

This patch introduces aural updates as one interacts with the in-place editing components through an ARIA live message region.

Use ChromeVox or another screen reader while you're using the in-place editing to hear the messages.

I committed this patch to the 8.x-1.x branch of the Edit module.

jessebeach’s picture

Status: Active » Closed (fixed)

This patch has been incorporated into #1824500-46: In-place editing for Fields.

Liam Morland’s picture

Issue tags: -a11y +accessibility