@gitlab/ui 123.9.1 → 123.10.0

package/dist/utils/unique_id.js

@@ -0,0 +1,18 @@
+/**
+ * Function uses browser native crypto to return a sixteen
+ * character base16 encoded string. It is often used to
+ * generate collision-resistant IDs for aria markup such
+ * as aria-activedescendant and aria-controls.
+ *
+ * @returns String
+ */
+const GlUniqueId = () => {
+  if (typeof window !== 'undefined' && window.crypto) {
+    const arr32 = new Uint32Array(2);
+    window.crypto.getRandomValues(arr32);
+    return Array.from(arr32, id => id.toString(16)).join('');
+  }
+  throw new Error('Cannot generate a unique ID');
+};
+
+export { GlUniqueId };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "123.9.1",
+  "version": "123.10.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/base/filtered_search/filtered_search.scss

@@ -8,7 +8,7 @@
   @apply gl-pl-4;
   @apply gl-pr-7;
   @apply gl-border-none;
-  @apply gl-rounded-default;
+  @apply gl-rounded-control;
   box-shadow: inset 0 0 0 $gl-border-size-1 var(--gl-control-border-color-default);
   background-color: var(--gl-control-background-color-default);
 

package/src/components/base/token_selector/token_container.vue

@@ -13,11 +13,6 @@ export default {
       validator: tokensValidator,
       required: true,
     },
-    state: {
-      type: Boolean,
-      required: false,
-      default: null,
-    },
     registerFocusOnToken: {
       type: Function,
       required: true,
@@ -133,11 +128,6 @@ export default {
       <div
         ref="tokenContainer"
         class="-gl-mx-1 -gl-my-1 gl-flex gl-w-auto gl-list-none gl-flex-wrap gl-items-center gl-p-0"
-        role="listbox"
-        aria-multiselectable="false"
-        aria-orientation="horizontal"
-        :aria-invalid="state === false && 'true'"
-        aria-label="token list"
         @keydown.left="handleLeftArrow"
         @keydown.right="handleRightArrow"
         @keydown.home="handleHome"
@@ -152,7 +142,7 @@ export default {
           :key="token.id"
           :data-token-id="token.id"
           class="gl-token-selector-token-container gl-px-1 gl-py-2 gl-outline-none"
-          role="option"
+          data-testid="gl-token-selector-tokens"
           tabindex="-1"
           @focus="bindFocusEvent ? handleTokenFocus(index) : null"
         >

package/src/components/base/token_selector/token_selector.vue

@@ -1,12 +1,11 @@
 <script>
-import uniqueId from 'lodash/uniqueId';
+import { GlUniqueId } from '../../../utils/unique_id';
 import { tokensValidator } from './helpers';
 import GlTokenContainer from './token_container.vue';
 import GlTokenSelectorDropdown from './token_selector_dropdown.vue';
 
 export default {
   name: 'GlTokenSelector',
-  componentId: uniqueId('token-selector'),
   components: {
     GlTokenContainer,
     GlTokenSelectorDropdown,
@@ -75,7 +74,7 @@ export default {
       default: '',
     },
     /**
-     * The autocomplete attribute value for the underlying `input` element
+     * The HTML5 autocomplete attribute value for the underlying `input` element.
      */
     autocomplete: {
       type: String,
@@ -83,7 +82,21 @@ export default {
       default: 'off',
     },
     /**
-     * The `aria-labelledby` attribute value for the underlying `input` element
+     * The `aria-label` attribute value for the underlying `input` element.
+     * Input must have an aria-label or aria-labelledby prop or it will be inaccessible.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label
+     */
+    ariaLabel: {
+      type: String,
+      required: false,
+      default: null,
+    },
+    /**
+     * The `aria-labelledby` attribute value for the underlying `input` element.
+     * String must match the unique ID on a text element to create an accessible label.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-labelledby
      */
     ariaLabelledby: {
       type: String,
@@ -237,6 +250,10 @@ export default {
       }
     },
   },
+  created() {
+    // Each instance must have a unique ID for proper ARIA relationships
+    this.uniqueId = `token-selector-${GlUniqueId()}`;
+  },
   methods: {
     handleFocus(event) {
       /**
@@ -382,6 +399,13 @@ export default {
       this.$emit('input', []);
       this.focusTextInput();
     },
+    handleAriaInvalid() {
+      const { state } = this;
+      return state === false ? 'true' : null;
+    },
+    handleAriaActiveDescendent(value) {
+      return value ? `${this.uniqueId}-dropdown-item-${value.id}` : null;
+    },
   },
 };
 </script>
@@ -428,10 +452,17 @@ export default {
             type="text"
             class="gl-token-selector-input gl-h-auto gl-w-4/10 gl-grow gl-border-none gl-bg-transparent gl-px-1 gl-font-regular gl-text-base gl-leading-normal gl-text-default gl-outline-none"
             :value="inputText"
+            :aria-activedescendant="handleAriaActiveDescendent(focusedDropdownItem)"
             :autocomplete="autocomplete"
+            :aria-controls="uniqueId"
+            :aria-expanded="dropdownIsOpen.toString()"
+            :aria-invalid="handleAriaInvalid()"
+            :aria-label="ariaLabelledby ? null : ariaLabel"
             :aria-labelledby="ariaLabelledby"
             :placeholder="placeholder"
             :disabled="viewOnly"
+            aria-autocomplete="list"
+            role="combobox"
             v-bind="textInputAttrs"
             @input="inputText = $event.target.value"
             @focus="handleFocus"
@@ -450,18 +481,18 @@ export default {
       </gl-token-container>
     </div>
     <gl-token-selector-dropdown
-      v-model="focusedDropdownItem"
       :menu-class="menuClass"
       :show="dropdownIsOpen"
       :loading="loading"
       :dropdown-items="filteredDropdownItems"
-      :selected-tokens="selectedTokens"
       :input-text="inputText"
       :user-defined-token-can-be-added="userDefinedTokenCanBeAdded"
-      :component-id="$options.componentId"
+      :component-id="uniqueId"
       :register-dropdown-event-handlers="registerDropdownEventHandlers"
       :register-reset-focused-dropdown-item="registerResetFocusedDropdownItem"
       @dropdown-item-click="addToken"
+      @input="focusedDropdownItem = $event"
+      @aria-active-descendant="handleAriaActiveDescendent"
       @show="openDropdown"
     >
       <template #loading-content

package/src/components/base/token_selector/token_selector_dropdown.vue

@@ -106,7 +106,6 @@ export default {
     });
 
     this.registerResetFocusedDropdownItem(this.resetFocusedDropdownItem);
-
     this.$emit('input', this.focusedDropdownItem);
   },
   methods: {
@@ -199,13 +198,13 @@ export default {
 <template>
   <div class="dropdown b-dropdown gl-dropdown gl-relative" :class="{ show }">
     <ul
+      :id="componentId"
       ref="dropdownMenu"
-      role="menu"
+      role="listbox"
       class="dropdown-menu gl-absolute"
-      :aria-activedescendant="dropdownItemIdAttribute(focusedDropdownItem)"
       :class="[{ show }, menuClass]"
     >
-      <gl-dropdown-item v-if="loading" disabled>
+      <gl-dropdown-item v-if="loading" role="option" disabled>
         <slot name="loading-content">Searching...</slot>
       </gl-dropdown-item>
 
@@ -216,7 +215,9 @@ export default {
         :key="dropdownItem.id"
         :data-dropdown-item-id="dropdownItem.id"
         :active="dropdownItemIsFocused(dropdownItem)"
+        :aria-selected="dropdownItemIsFocused(dropdownItem).toString()"
         active-class="is-focused"
+        role="option"
         tabindex="-1"
         @click="handleDropdownItemClick(dropdownItem)"
       >
@@ -234,6 +235,7 @@ export default {
         :data-dropdown-item-id="userDefinedToken.id"
         :active="dropdownItemIsFocused(userDefinedToken)"
         active-class="is-focused"
+        role="option"
         tabindex="-1"
         @click="handleDropdownItemClick(userDefinedToken)"
       >
@@ -247,7 +249,7 @@ export default {
         </div>
       </gl-dropdown-item>
 
-      <gl-dropdown-item v-else-if="!dropdownItems.length" disabled>
+      <gl-dropdown-item v-else-if="!dropdownItems.length" role="option" disabled>
         <slot name="no-results-content">No matches found</slot>
       </gl-dropdown-item>
 

package/src/utils/unique_id.js

@@ -0,0 +1,17 @@
+/**
+ * Function uses browser native crypto to return a sixteen
+ * character base16 encoded string. It is often used to
+ * generate collision-resistant IDs for aria markup such
+ * as aria-activedescendant and aria-controls.
+ *
+ * @returns String
+ */
+export const GlUniqueId = () => {
+  if (typeof window !== 'undefined' && window.crypto) {
+    const arr32 = new Uint32Array(2);
+    window.crypto.getRandomValues(arr32);
+    return Array.from(arr32, (id) => id.toString(16)).join('');
+  }
+
+  throw new Error('Cannot generate a unique ID');
+};