Contrib.social

Dialog buttons do not inherit accessibility-related attributes

Open on Drupal.org →
Created on 11 July 2024, about 2 months ago
Updated 26 July 2024, about 1 month ago

Problem/Motivation

When creating a modal dialog (e.g., via an AJAX-enabled link), Drupal duplicates any form actions found within the modal content for display in a button pane at the bottom of the dialog. At present, only the following attributes are copied:

This poses a significant hurdle to providing accessible form actions, especially since HTML cannot be used within the value attribute produced by submit/button render elements.

<!--break-->

Steps to reproduce

  1. Create a form with an action that has one or more attributes listed below.
  2. Create a page with a link to the form which will open in a modal dialog.
  3. Click the link from the last step and observe that the duplicated button is missing the attribute(s) from the first step.

Proposed resolution

We should additionally copy the following attributes to the duplicated buttons:

  • aria-description
  • aria-details
  • aria-label
  • disabled (allows the button to be disabled, which implicitly confers applicable accessibility information)
  • title (additionally allows a tool-tip to be displayed)

I've omitted aria-describedby and aria-labelledby for now since I don't think developers would intentionally create code that leaves dangling content in the modal content. The assumption is that developers would avoid using the button pane entirely in this case. I would be happy to include these, however, if the community believes they're also useful.

I've included aria-details because the detail text could ostensibly apply to other things than just form actions.

Remaining tasks

Update core/misc/dialog/dialog.ajax.js, specifically prepareDialogButtons() in the dialog behavior.

User interface changes

Modal dialog buttons will be more accurately duplicated.

API changes

None.

Data model changes

None?

Release notes snippet

TBD

🐛 Bug report
Status

Needs review

Version

11.0 🔥

Component
Ajax  →

Last updated about 20 hours ago

Created by

🇺🇸United States clayfreeman Paragould, AR

Live updates comments and jobs are added and updated live.
  • Needs accessibility review

    Used to alert the accessibility topic maintainer(s) that an issue significantly affects (or has the potential to affect) the accessibility of Drupal, and their signoff is needed (see the governance policy draft for more information). Useful links: Drupal's accessibility standards, the Drupal Core accessibility gate.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @clayfreeman
  • Merge request !8744Dialog buttons do not inherit accessibility-related attributes → (Open) created by clayfreeman
  • Comment about 2 months ago →
    🇺🇸United States clayfreeman Paragould, AR

    Would appreciate an expert's review to ensure the work is sufficient :)

  • Pipeline finished with Success
    about 2 months ago
    Total: 528s
    #222001
  • Status changed to Needs review about 2 months ago
  • Comment about 2 months ago →
    🇺🇸United States clayfreeman Paragould, AR

    Pipeline seems to have passed; ready for manual review now.

  • Pipeline finished with Success
    about 2 months ago
    Total: 811s
    #222147
  • Comment about 2 months ago →
    🇷🇸Serbia finnsky

    I've added one comment here. Probably it will help

  • Status changed to RTBC about 2 months ago
  • Comment about 2 months ago →
    jeremyvii

    This looks good to me. All the new attributes are copied over in the submit button when a form is loaded in a modal.

  • Status changed to Needs work about 1 month ago
  • Comment about 1 month ago →
    🇳🇿New Zealand quietone New Zealand

    There is a comment about adding a followup issue. Is that needed? Adding tag just in case.

    This is tagged for an accessibility review. That still needs to happen. I am not sure of the process but asking in #accessibility is a start.

  • Status changed to Needs review about 1 month ago
  • Comment about 1 month ago →
    🇺🇸United States clayfreeman Paragould, AR

    I don't believe the follow-up is needed, or at least it shouldn't block the work being done here. I'm happy to entertain the proposed change if Drupal core is willing to take on such a task, but I doubt the likelihood of that outcome.

    I'll post in #accessibility -- thanks for the suggestion.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024