reactjs/react-modal

Accessibility issues with the codepen demos

Open

#955 建立於 2022年6月21日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)JavaScript (7,294 star) (828 fork)batch import
documentationexamplesgood first issue

描述

Summary:

Many of the demos linked to from the README have accessibility issues:

  • Minimal example - once the modal is opened, aria-hidden="true" is set on the <body>. this also hides the modal itself (which is a child element of the <body>) from screen readers; when the modal is closed, focus is not returned explicitly to the "Trigger modal" button
  • Using setAppElement - same issues as the minimal example
  • Using inline styles - when the modal is closed, focus is not returned explicitly to the "Trigger modal" button
  • Customizing the default styles - while the #1 modal is fine, when triggering #2 modal the <body> is once again hidden with aria-hidden="true" and, as a result, the #2 modal is also hidden from screen readers

Steps to reproduce:

  1. Use a screen reader
  2. Open the codepen demos
  3. Open/close the various modals

Expected behavior:

  • don't set aria-hidden="true" on the <body> itself, as this will hide everything from screen readers, including the dialog
  • make sure that focus is returned to the button that first opened the modal

Review how the working demos like Using inline styles do it, and apply the same behavior to the broken demos.

貢獻者指南

技術棧
reacthtmlcss
領域
frontendaccessibility
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic React knowledgeunderstanding of ARIA attributesfamiliarity with focus management
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Review the linked codepen demos in the issue (Minimal example, Using setAppElement, Using inline styles, Customizing the default styles). The main problems are: 1) setting `aria hidden="true"` on `<body>` when modal opens, which hides the modal from screen readers; 2) focus not being returned to the trigger button when modal closes. For each demo, adjust the code to use `aria hidden` on a wrapper inside the body (or use the `appElement` properly) and ensure focus is returned on close. The fix will involve modifying the React component code in those demos. No changes to the library itself are needed, only the example demos.