coreui / coreui-pro / 37217528722

96%

main: 94%

push

github

feat(Toaster): announce toasts through a live region shared by the page (#1557)

* feat(Toaster): announce toasts through a live region shared by the page

announce(message, { priority, timeout }) reads a message to screen reader
users through one visually hidden pair of log regions, created at the start
of <body> on the first call. While a modal dialog is open the rest of the page
is inert, so the message goes to regions inside the topmost open modal dialog
instead, which leave with it when it closes. Messages wait in one queue per
region, so a burst keeps its order, and the first one waits 100 ms after the
region is created. It returns a function that removes the message or cancels
it before it is added.

It is exported from the package root (coreui.announce in the UMD bundle) and
as @coreui/coreui-pro/utils/announce, built like the other utils for the
React and Vue packages.

Toaster calls it on add and update instead of keeping two regions in its
container, so a toast is announced while a modal dialog is open, and a
message is still read when the toaster is disposed right after adding it.

* chore: raise the JS bundle budgets for announce()

Measured against origin/v6-dev with gzip -9 on both builds: announce() and
the Toaster switching to it add 1254 to 1259 B to the three unminified
bundles, most of it the util's JSDoc, which the unminified bundles keep, and
395 to 401 B to the three minified ones. The base had about 0.2 KB of room,
so all six JS ceilings were exceeded; each goes up to leave 0.28 to 0.44 KB.

* fix(Toaster): pick the announcement region when the message is added

announce() chose the page or the modal dialog when it was called and added
the message a task or 100 ms later, so a dialog opened in between, such as
one holding the toaster, left the message in the inert page region. Messages
now wait in one queue and each picks its region when it is added: the modal
dialog holding focus, then the one around the new `context` option, t... (continued)

6878 of 7430 branches covered (92.57%)

Branch coverage included in aggregate %.

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

12039 of 12332 relevant lines covered (97.62%)

1485.96 hits per line