coreui / coreui-pro / 38153650846

96%

main: 94%

Build Type

push

github

Committed by web-flow

Commit Message

refactor(announce): let the dialog components hold messages instead of a MutationObserver (#1611)

`announce()` held its regions for 500 ms after a dialog closed by watching the `open` attribute across the whole document with a `MutationObserver` started at import. When a modal dialog closes, the rest of the page comes back to screen readers, and VoiceOver dropped a message added at that moment in Chrome, Safari and Firefox, so the hold stays; only the way it learns about the close changes.

Modal, Offcanvas, Dialog and Drawer now call the exported `holdAnnouncements()` in `_closeAndCleanup()`, right after `close()` and before `hidden` fires, which covers `hide()`, an animated close at the end of the transition, `dispose()` while open and a native close. The React and Vue dialog hooks call it as well (coreui-react-pro#628, coreui-vue-pro#563), which is why it is exported from `utils/announce`. A `<dialog>` the page opens and closes itself is no longer waited for; the accessibility page says to send a message meant for the page about half a second after closing it. The queue still waits while a modal plays its closing transition. Nothing runs at import any more.

Specs cover the hold from an instant and an animated Modal, a message sent during the closing transition, a nested dialog, the first message of a page, and a page's own dialog that is not held; each fails under a mutation of its line.

Coverage Stats

7751 of 8336 branches covered (92.98%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 2 files covered. (100.0%)

1 existing line in 1 file now uncovered.

13366 of 13662 relevant lines covered (97.83%)

1636.43 hits per line