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

Make remove from collection button announced by screen reader

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Critical
    • Resolution: Done
    • Affects Version/s: 3.0.15
    • Fix Version/s: 3.0.16
    • Component/s: A11y

      Description

      in web ui:
      browse a document
      add it to a collection or to your favorites
      on the right side (metadata layout), the collection name appears like a badge
      => the remove button there is not announced by the screen reader, it's missing a role and label
      expected: button should be announced by screen reader

      _____________________
      The button is missing both a role and an accessible name/label.

      Element Name: Remove /Clear button under Collections

      NVDA Is narrating name as clickable when its focus is on each of the 'Remove /Clear button under Collections'
      Recommendation to fix
      RULE :
      The name, role, value, states, and properties of user interface components MUST be programmatically determinable by assistive technologies.

      HOW TO FIX:
      To fix this issue, BOTH a ROLE and a NAME must be provided for the button.

      Provide a ROLE by using one of the following techniques:
      1. Use a native HTML <button> element.

      <button>Apply now!</button>

      2. Add role="button" to the custom button container.

      <span role="button" class="apply-btn" aria-label="Apply Now!"></span>

      Provide a NAME by using any of the following techniques:
      1. Use the innertext of the <button> or role="button" element

      <button>Apply now!</button>

      <button class="apply-btn"><span class="sr-text">Apply now!</span></button>

      2. Use a non-empty aria-label attribute on the <button> or role="button" element.

      <button class="apply-btn" aria-label="Apply now!"></button>

      <span role="button" class="apply-btn" aria-label="Apply Now!"></span>

      REFERENCE:
      Deque University: https://dequeuniversity.com/class/custom-widgets/concepts/name
      Deque University: https://dequeuniversity.com/class/custom-widgets/examples/button
      W3C ARIA Recommendation: https://www.w3.org/TR/wai-aria-1.1/#aria-label

      BACKGROUND:
      Every user interface control must have a role to convey what type of control it is for screen reader and other assistive technology users. Native HTML elements - such as <button>, <a>, <input>, <select> - already have a role, so nothing more needs to be done. If you create a custom version of a native HTML element or a custom control or widget that does not have a native HTML equivalent, you must add the relevant role(s) using ARIA as well as expected keyboard interactions.

      Buttons must have discernible text that describes the button's function or action for screen reader and other assistive technology users.

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: