@primer/view-components 0.35.1 → 0.35.2-rc.4013086b

package/app/components/primer/alpha/select_panel_element.d.ts

@@ -1,5 +1,7 @@
 import { IncludeFragmentElement } from '@github/include-fragment-element';
 import type { AnchorAlignment, AnchorSide } from '@primer/behaviors';
+import type { LiveRegionElement } from '@primer/live-region-element';
+import '@primer/live-region-element';
 import '@oddbird/popover-polyfill';
 type SelectVariant = 'none' | 'single' | 'multiple' | null;
 type SelectedItem = {
@@ -16,11 +18,11 @@ export declare class SelectPanelElement extends HTMLElement {
     filterInputTextField: HTMLInputElement;
     remoteInput: HTMLElement;
     list: HTMLElement;
-    ariaLiveContainer: HTMLElement;
     noResults: HTMLElement;
     fragmentErrorElement: HTMLElement;
     bannerErrorElement: HTMLElement;
     bodySpinner: HTMLElement;
+    liveRegion: LiveRegionElement;
     filterFn?: FilterFn;
     get open(): boolean;
     get selectVariant(): SelectVariant;

package/app/components/primer/alpha/select_panel_element.js

@@ -18,8 +18,8 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
 var _SelectPanelElement_instances, _SelectPanelElement_dialogIntersectionObserver, _SelectPanelElement_abortController, _SelectPanelElement_originalLabel, _SelectPanelElement_inputName, _SelectPanelElement_selectedItems, _SelectPanelElement_loadingDelayTimeoutId, _SelectPanelElement_loadingAnnouncementTimeoutId, _SelectPanelElement_hasLoadedData, _SelectPanelElement_waitForCondition, _SelectPanelElement_softDisableItems, _SelectPanelElement_updateTabIndices, _SelectPanelElement_potentiallyDisallowActivation, _SelectPanelElement_isAnchorActivationViaSpace, _SelectPanelElement_isActivation, _SelectPanelElement_checkSelectedItems, _SelectPanelElement_addSelectedItem, _SelectPanelElement_removeSelectedItem, _SelectPanelElement_setTextFieldLoadingSpinnerTimer, _SelectPanelElement_handleIncludeFragmentEvent, _SelectPanelElement_toggleIncludeFragmentElements, _SelectPanelElement_handleRemoteInputEvent, _SelectPanelElement_defaultFilterFn, _SelectPanelElement_handleSearchFieldEvent, _SelectPanelElement_updateItemVisibility, _SelectPanelElement_inErrorState, _SelectPanelElement_setErrorState, _SelectPanelElement_clearErrorState, _SelectPanelElement_maybeAnnounce, _SelectPanelElement_fetchStrategy_get, _SelectPanelElement_filterInputTextFieldElement_get, _SelectPanelElement_performFilteringLocally, _SelectPanelElement_handleInvokerActivated, _SelectPanelElement_handleDialogItemActivated, _SelectPanelElement_handleItemActivated, _SelectPanelElement_setDynamicLabel, _SelectPanelElement_updateInput, _SelectPanelElement_firstItem_get, _SelectPanelElement_hideItem, _SelectPanelElement_showItem, _SelectPanelElement_getItemContent;
 import { getAnchoredPosition } from '@primer/behaviors';
 import { controller, target } from '@github/catalyst';
-import { announceFromElement, announce } from '../aria_live';
 import { IncludeFragmentElement } from '@github/include-fragment-element';
+import '@primer/live-region-element';
 import '@oddbird/popover-polyfill';
 const validSelectors = ['[role="option"]'];
 const menuItemSelectors = validSelectors.join(',');
@@ -525,7 +525,7 @@ _SelectPanelElement_setTextFieldLoadingSpinnerTimer = function _SelectPanelEleme
     if (__classPrivateFieldGet(this, _SelectPanelElement_loadingAnnouncementTimeoutId, "f"))
         clearTimeout(__classPrivateFieldGet(this, _SelectPanelElement_loadingAnnouncementTimeoutId, "f"));
     __classPrivateFieldSet(this, _SelectPanelElement_loadingAnnouncementTimeoutId, setTimeout(() => {
-        announce('Loading', { element: this.ariaLiveContainer });
+        this.liveRegion.announce('Loading');
     }, 2000), "f");
     __classPrivateFieldSet(this, _SelectPanelElement_loadingDelayTimeoutId, setTimeout(() => {
         __classPrivateFieldGet(this, _SelectPanelElement_instances, "a", _SelectPanelElement_filterInputTextFieldElement_get)?.showLeadingSpinner();
@@ -551,7 +551,7 @@ _SelectPanelElement_handleIncludeFragmentEvent = function _SelectPanelElement_ha
             const errorElement = this.fragmentErrorElement;
             // check if the errorElement is visible in the dom
             if (errorElement && !errorElement.hasAttribute('hidden')) {
-                announceFromElement(errorElement, { element: this.ariaLiveContainer, assertive: true });
+                this.liveRegion.announceFromElement(errorElement, { politeness: 'assertive' });
                 return;
             }
             break;
@@ -738,7 +738,7 @@ _SelectPanelElement_setErrorState = function _SelectPanelElement_setErrorState(t
     }
     // check if the errorElement is visible in the dom
     if (errorElement && !errorElement.hasAttribute('hidden')) {
-        announceFromElement(errorElement, { element: this.ariaLiveContainer, assertive: true });
+        this.liveRegion.announceFromElement(errorElement, { politeness: 'assertive' });
         return;
     }
 };
@@ -748,17 +748,15 @@ _SelectPanelElement_clearErrorState = function _SelectPanelElement_clearErrorSta
 };
 _SelectPanelElement_maybeAnnounce = function _SelectPanelElement_maybeAnnounce() {
     if (this.open && this.list) {
-        const items = this.items;
+        const items = this.visibleItems;
         if (items.length > 0) {
             const instructions = 'tab for results';
-            announce(`${items.length} result${items.length === 1 ? '' : 's'} ${instructions}`, {
-                element: this.ariaLiveContainer,
-            });
+            this.liveRegion.announce(`${items.length} result${items.length === 1 ? '' : 's'} ${instructions}`);
         }
         else {
             const noResultsEl = this.noResults;
             if (noResultsEl) {
-                announceFromElement(noResultsEl, { element: this.ariaLiveContainer });
+                this.liveRegion.announceFromElement(noResultsEl);
             }
         }
     }
@@ -976,9 +974,6 @@ __decorate([
 __decorate([
     target
 ], SelectPanelElement.prototype, "list", void 0);
-__decorate([
-    target
-], SelectPanelElement.prototype, "ariaLiveContainer", void 0);
 __decorate([
     target
 ], SelectPanelElement.prototype, "noResults", void 0);
@@ -991,6 +986,9 @@ __decorate([
 __decorate([
     target
 ], SelectPanelElement.prototype, "bodySpinner", void 0);
+__decorate([
+    target
+], SelectPanelElement.prototype, "liveRegion", void 0);
 SelectPanelElement = __decorate([
     controller
 ], SelectPanelElement);

package/app/components/primer/primer.d.ts

@@ -7,7 +7,6 @@ import './anchored_position';
 import './dialog_helper';
 import './focus_group';
 import './scrollable_region';
-import './aria_live';
 import './shared_events';
 import './alpha/modal_dialog';
 import './beta/nav_list';

package/app/components/primer/primer.js

@@ -7,7 +7,6 @@ import './anchored_position';
 import './dialog_helper';
 import './focus_group';
 import './scrollable_region';
-import './aria_live';
 import './shared_events';
 import './alpha/modal_dialog';
 import './beta/nav_list';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/view-components",
-  "version": "0.35.1",
+  "version": "0.35.2-rc.4013086b",
   "description": "ViewComponents for the Primer Design System",
   "main": "app/assets/javascripts/primer_view_components.js",
   "module": "app/components/primer/primer.js",
@@ -53,6 +53,7 @@
     "@github/relative-time-element": "^4.0.0",
     "@github/remote-input-element": "^0.4.0",
     "@github/tab-container-element": "^3.1.2",
+    "@primer/live-region-element": "^0.7.1",
     "@oddbird/popover-polyfill": "^0.4.0",
     "@primer/behaviors": "^1.3.4"
   },

package/app/assets/javascripts/components/primer/aria_live.d.ts

@@ -1,8 +0,0 @@
-export declare function announceFromElement(el: HTMLElement, options?: {
-    assertive?: boolean;
-    element?: HTMLElement;
-}): void;
-export declare function announce(message: string, options?: {
-    assertive?: boolean;
-    element?: HTMLElement;
-}): void;

package/app/components/primer/aria_live.d.ts

@@ -1,8 +0,0 @@
-export declare function announceFromElement(el: HTMLElement, options?: {
-    assertive?: boolean;
-    element?: HTMLElement;
-}): void;
-export declare function announce(message: string, options?: {
-    assertive?: boolean;
-    element?: HTMLElement;
-}): void;

package/app/components/primer/aria_live.js

@@ -1,38 +0,0 @@
-const safeDocument = typeof document === 'undefined' ? undefined : document;
-// Announce an element's text to the screen reader.
-export function announceFromElement(el, options) {
-    announce(getTextContent(el), options);
-}
-// Announce message update to screen reader.
-// Note: Use caution when using this function while a dialog is active.
-// If the message is updated while the dialog is open, the screen reader may not announce the live region.
-export function announce(message, options) {
-    const { assertive, element } = options ?? {};
-    setContainerContent(message, assertive, element);
-}
-// Set aria-live container to message.
-function setContainerContent(message, assertive, element) {
-    const getQuerySelector = () => {
-        return assertive ? '#js-global-screen-reader-notice-assertive' : '#js-global-screen-reader-notice';
-    };
-    const container = element ?? safeDocument?.querySelector(getQuerySelector());
-    if (!container)
-        return;
-    if (container.textContent === message) {
-        /* This is a hack due to the way the aria live API works.
-        A screen reader will not read a live region again
-        if the text is the same. Adding a space character tells
-        the browser that the live region has updated,
-        which will cause it to read again, but with no audible difference. */
-        container.textContent = `${message}\u00A0`;
-    }
-    else {
-        container.textContent = message;
-    }
-}
-// Gets the trimmed text content of an element.
-function getTextContent(el) {
-    // innerText does not contain hidden text
-    /* eslint-disable-next-line github/no-innerText */
-    return (el.getAttribute('aria-label') || el.innerText || '').trim();
-}