@instructure/ui-alerts 10.4.1-snapshot-5 → 10.4.1

package/CHANGELOG.md

@@ -3,11 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [10.4.1-snapshot-5](https://github.com/instructure/instructure-ui/compare/v10.4.0...v10.4.1-snapshot-5) (2024-10-28)
+## [10.4.1](https://github.com/instructure/instructure-ui/compare/v10.4.0...v10.4.1) (2024-10-28)
 
 
 ### Bug Fixes
 
+* docs screenreader alerts are no longer screendeader focusable ([c225853](https://github.com/instructure/instructure-ui/commit/c2258531aa377b698fe932012112704f1879b501))
 * update license ([1c039d9](https://github.com/instructure/instructure-ui/commit/1c039d9cbf5a3ea99b59803ddde5c6c0b2d76ba5))
 
 

package/es/Alert/index.js

@@ -109,6 +109,9 @@ let Alert = (_dec = withDeterministicId(), _dec2 = withStyle(generateStyle, gene
     error(liveRegion.getAttribute('role') === 'alert', `[Alert] live region must have role='alert' set on page load in order to announce content`);
     if (liveRegion) {
       liveRegion.setAttribute('aria-live', this.props.liveRegionPoliteness);
+      // indicates what notifications the user agent will trigger when the
+      // accessibility tree within a live region is modified.
+      // additions: elements are added, text: Text content is added
       liveRegion.setAttribute('aria-relevant', 'additions text');
       liveRegion.setAttribute('aria-atomic', `${this.props.isLiveRegionAtomic}`);
     }

package/lib/Alert/index.js

@@ -121,6 +121,9 @@ let Alert = exports.Alert = (_dec = (0, _withDeterministicId.withDeterministicId
     (0, _console.logError)(liveRegion.getAttribute('role') === 'alert', `[Alert] live region must have role='alert' set on page load in order to announce content`);
     if (liveRegion) {
       liveRegion.setAttribute('aria-live', this.props.liveRegionPoliteness);
+      // indicates what notifications the user agent will trigger when the
+      // accessibility tree within a live region is modified.
+      // additions: elements are added, text: Text content is added
       liveRegion.setAttribute('aria-relevant', 'additions text');
       liveRegion.setAttribute('aria-atomic', `${this.props.isLiveRegionAtomic}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-alerts",
-  "version": "10.4.1-snapshot-5",
+  "version": "10.4.1",
   "description": "An alert component",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-axe-check": "10.4.1-snapshot-5",
-    "@instructure/ui-babel-preset": "10.4.1-snapshot-5",
-    "@instructure/ui-color-utils": "10.4.1-snapshot-5",
-    "@instructure/ui-scripts": "10.4.1-snapshot-5",
-    "@instructure/ui-test-utils": "10.4.1-snapshot-5",
+    "@instructure/ui-axe-check": "10.4.1",
+    "@instructure/ui-babel-preset": "10.4.1",
+    "@instructure/ui-color-utils": "10.4.1",
+    "@instructure/ui-scripts": "10.4.1",
+    "@instructure/ui-test-utils": "10.4.1",
     "@testing-library/jest-dom": "^6.4.6",
     "@testing-library/react": "^16.0.1",
     "@testing-library/user-event": "^14.5.2",
@@ -35,16 +35,16 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.25.6",
-    "@instructure/console": "10.4.1-snapshot-5",
-    "@instructure/emotion": "10.4.1-snapshot-5",
-    "@instructure/shared-types": "10.4.1-snapshot-5",
-    "@instructure/ui-a11y-content": "10.4.1-snapshot-5",
-    "@instructure/ui-buttons": "10.4.1-snapshot-5",
-    "@instructure/ui-icons": "10.4.1-snapshot-5",
-    "@instructure/ui-motion": "10.4.1-snapshot-5",
-    "@instructure/ui-react-utils": "10.4.1-snapshot-5",
-    "@instructure/ui-themes": "10.4.1-snapshot-5",
-    "@instructure/ui-view": "10.4.1-snapshot-5",
+    "@instructure/console": "10.4.1",
+    "@instructure/emotion": "10.4.1",
+    "@instructure/shared-types": "10.4.1",
+    "@instructure/ui-a11y-content": "10.4.1",
+    "@instructure/ui-buttons": "10.4.1",
+    "@instructure/ui-icons": "10.4.1",
+    "@instructure/ui-motion": "10.4.1",
+    "@instructure/ui-react-utils": "10.4.1",
+    "@instructure/ui-themes": "10.4.1",
+    "@instructure/ui-view": "10.4.1",
     "keycode": "^2",
     "prop-types": "^15.8.1"
   },

package/src/Alert/index.tsx

@@ -153,6 +153,9 @@ class Alert extends Component<AlertProps, AlertState> {
 
     if (liveRegion) {
       liveRegion.setAttribute('aria-live', this.props.liveRegionPoliteness!)
+      // indicates what notifications the user agent will trigger when the
+      // accessibility tree within a live region is modified.
+      // additions: elements are added, text: Text content is added
       liveRegion.setAttribute('aria-relevant', 'additions text')
       liveRegion.setAttribute(
         'aria-atomic',

package/src/Alert/props.ts

@@ -53,11 +53,23 @@ type AlertOwnProps = {
    */
   liveRegion?: () => Element
   /**
-   * Choose the politeness level of screenreader alerts.
+   * Choose the politeness level of screenreader alerts, sets the value of
+   * `aria-live`.
+   *
+   * When regions are specified as `polite`, assistive technologies will notify
+   * users of updates but generally do not interrupt the current task,
+   * and updates take low priority.
+   *
+   * When regions are specified as `assertive`, assistive technologies will
+   * immediately notify the user, and could potentially clear the speech queue
+   * of previous updates.
    */
   liveRegionPoliteness?: 'polite' | 'assertive'
   /**
-   * If the screenreader alert should be atomic
+   * Value for the `aria-atomic` attribute.
+   * `aria-atomic` controls how much is read when a change happens. Should only
+   * the specific thing that changed be read or should the entire element be
+   * read.
    */
   isLiveRegionAtomic?: boolean
   /**