Uploaded image for project: 'Nuxeo Web UI'
  1. Nuxeo Web UI
  2. WEBUI-514

Make the number of search results announced by the screen reader

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 3.0.15
    • Fix Version/s: 3.0.17
    • Component/s: A11y

      Description

      Related to WCAG 2.1 level AA criteria 4.1.3: status messages
      https://www.w3.org/TR/WCAG21/#status-messages

      Status message is not automatically announced by the screen reader.

      Element:

      • "xx results"

      Location:

      • "Search results" section

      On entering text in the "Full Search" input field in the "Search Filters" section, the results get updated. However, the same information is not announced automatically to the screen reader users.
      Recommendation to fix
      RULE :
      Status messages MUST be programmatically determined through role or properties such that they can be presented to the user by assistive technologies without receiving focus.

      HOW TO FIX:
      Fix this issue by using an ARIA live region so screen readers can automatically announce the status message content.
      <div aria-live="assertive">Your form was successfully submitted</div>
      <div role="alert">Please correct the errors below to continue</div>

      REFERENCE:
      Deque University:https://dequeuniversity.com/class/dynamic-updates2/notify-users/aria-live
      WCAG Understanding document: https://www.w3.org/WAI/WCAG21/Understanding/status-messages

      BACKGROUND:
      When a status message is added to a webpage, screen reader users will likely not know about the message if focus is not moved to the message. Often it is not desirable to interrupt a user's workflow to move focus to a status message, so people who are blind must be alerted programmatically to the presence of the status message. When a programmatic means of identifying the presence of status messages in used, assistive technologies such as screen readers are able to alert users to the presence of the message.
      NOTE: Status messages are defined as a change in content that is not a change of context (i.e. moving focus to a message) that provides information to the user on: 1) the success or results of an action ("Your form was successfully submitted"), 2) the loading state of an application ("processing your data request"), 3) the progress of a process ("50% complete"), or 4) the existence of errors ("Please correct the errors below to continue").

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 4 hours
                  4h