@gitlab/ui 58.2.0 → 58.2.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [58.2.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v58.2.0...v58.2.1) (2023-03-21)
+
+
+### Bug Fixes
+
+* **GlDisclosureDropdown:** Keep focus on toggle on open ([8dd3172](https://gitlab.com/gitlab-org/gitlab-ui/commit/8dd3172aaf304bad3b7a606dc6732af6a7390acf))
+
 # [58.2.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v58.1.0...v58.2.0) (2023-03-17)
 
 

package/dist/components/base/new_dropdowns/base_dropdown/base_dropdown.js

@@ -1,7 +1,7 @@
 import uniqueId from 'lodash/uniqueId';
 import { createPopper } from '@popperjs/core';
 import { buttonCategoryOptions, dropdownVariantOptions, buttonSizeOptions, dropdownPlacements } from '../../../../utils/constants';
-import { POPPER_CONFIG, GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, ENTER, SPACE } from '../constants';
+import { POPPER_CONFIG, GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, ENTER, SPACE, ARROW_DOWN, GL_DROPDOWN_FOCUS_CONTENT } from '../constants';
 import { isElementFocusable, isElementTabbable, logWarning } from '../../../../utils/utils';
 import GlButton from '../../button/button';
 import GlIcon from '../../icon/icon';
@@ -156,6 +156,7 @@ var script = {
           class: this.toggleButtonClasses,
           ...this.ariaAttributes,
           listeners: {
+            keydown: event => this.onKeydown(event),
             click: () => this.toggle()
           }
         };
@@ -253,11 +254,25 @@ var script = {
     },
     onKeydown(event) {
       const {
-        code
+        code,
+        target: {
+          tagName
+        }
       } = event;
-      if (code === ENTER || code === SPACE) {
+      let toggleOnEnter = true;
+      let toggleOnSpace = true;
+      if (tagName === 'BUTTON') {
+        toggleOnEnter = false;
+        toggleOnSpace = false;
+      } else if (tagName === 'A') {
+        toggleOnEnter = false;
+      }
+      if (code === ENTER && toggleOnEnter || code === SPACE && toggleOnSpace) {
         this.toggle();
       }
+      if (code === ARROW_DOWN) {
+        this.$emit(GL_DROPDOWN_FOCUS_CONTENT, event);
+      }
     }
   }
 };

package/dist/components/base/new_dropdowns/constants.js

@@ -10,6 +10,7 @@ const POPPER_CONFIG = {
 // base dropdown events
 const GL_DROPDOWN_SHOWN = 'shown';
 const GL_DROPDOWN_HIDDEN = 'hidden';
+const GL_DROPDOWN_FOCUS_CONTENT = 'focusContent';
 
 // KEY Codes
 const ARROW_DOWN = 'ArrowDown';
@@ -19,4 +20,4 @@ const ENTER = 'Enter';
 const HOME = 'Home';
 const SPACE = 'Space';
 
-export { ARROW_DOWN, ARROW_UP, END, ENTER, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_SHOWN, HOME, POPPER_CONFIG, SPACE };
+export { ARROW_DOWN, ARROW_UP, END, ENTER, GL_DROPDOWN_FOCUS_CONTENT, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_SHOWN, HOME, POPPER_CONFIG, SPACE };

package/dist/components/base/new_dropdowns/disclosure/disclosure_dropdown.js

@@ -1,7 +1,7 @@
 import clamp from 'lodash/clamp';
 import uniqueId from 'lodash/uniqueId';
 import { stopEvent, filterVisible } from '../../../../utils/utils';
-import { GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, HOME, END, ARROW_UP, ARROW_DOWN } from '../constants';
+import { GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_FOCUS_CONTENT, HOME, END, ARROW_UP, ARROW_DOWN } from '../constants';
 import { buttonCategoryOptions, dropdownVariantOptions, buttonSizeOptions, dropdownPlacements } from '../../../../utils/constants';
 import GlBaseDropdown from '../base_dropdown/base_dropdown';
 import GlDisclosureDropdownItem, { ITEM_CLASS } from './disclosure_dropdown_item';
@@ -13,7 +13,8 @@ import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 var script = {
   events: {
     GL_DROPDOWN_SHOWN,
-    GL_DROPDOWN_HIDDEN
+    GL_DROPDOWN_HIDDEN,
+    GL_DROPDOWN_FOCUS_CONTENT
   },
   components: {
     GlBaseDropdown,
@@ -177,11 +178,6 @@ var script = {
       this.$refs.baseDropdown.close();
     },
     onShow() {
-      const items = this.getFocusableListItemElements();
-      if (items.length) {
-        this.focusItem(0, items);
-      }
-
       /**
        * Emitted when dropdown is shown
        *
@@ -257,7 +253,7 @@ var script = {
 const __vue_script__ = script;
 
 /* template */
-var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('gl-base-dropdown',{ref:"baseDropdown",staticClass:"gl-disclosure-dropdown",attrs:{"aria-labelledby":_vm.toggleAriaLabelledBy,"toggle-id":_vm.toggleId,"toggle-text":_vm.toggleText,"toggle-class":_vm.toggleClass,"text-sr-only":_vm.textSrOnly,"category":_vm.category,"variant":_vm.variant,"size":_vm.size,"icon":_vm.icon,"disabled":_vm.disabled,"loading":_vm.loading,"no-caret":_vm.noCaret,"placement":_vm.placement},on:_vm._d({},[_vm.$options.events.GL_DROPDOWN_SHOWN,_vm.onShow,_vm.$options.events.GL_DROPDOWN_HIDDEN,_vm.onHide]),scopedSlots:_vm._u([(_vm.hasCustomToggle)?{key:"toggle",fn:function(){return [_vm._t("toggle")]},proxy:true}:null],null,true)},[_vm._v(" "),_vm._t("header"),_vm._v(" "),_c(_vm.disclosureTag,{ref:"content",tag:"component",staticClass:"gl-new-dropdown-contents",attrs:{"id":_vm.disclosureId,"aria-labelledby":_vm.listAriaLabelledBy || _vm.toggleId,"data-testid":"disclosure-content","tabindex":"-1"},on:{"keydown":_vm.onKeydown}},[_vm._t("default",function(){return [_vm._l((_vm.items),function(item,index){return [(_vm.isItem(item))?[_c('gl-disclosure-dropdown-item',{key:item.text,attrs:{"item":item},on:{"action":_vm.handleAction},scopedSlots:_vm._u([{key:"list-item",fn:function(){return [_vm._t("list-item",null,{"item":item})]},proxy:true}],null,true)})]:[_c('gl-disclosure-dropdown-group',{key:item.name,attrs:{"bordered":index !== 0,"group":item},on:{"action":_vm.handleAction},scopedSlots:_vm._u([(_vm.$scopedSlots['group-label'])?{key:"group-label",fn:function(){return [_vm._t("group-label",null,{"group":item})]},proxy:true}:null],null,true)},[_vm._v(" "),(_vm.$scopedSlots['list-item'])?_vm._l((item.items),function(groupItem){return _c('gl-disclosure-dropdown-item',{key:groupItem.text,attrs:{"item":groupItem},on:{"action":_vm.handleAction},scopedSlots:_vm._u([{key:"list-item",fn:function(){return [_vm._t("list-item",null,{"item":groupItem})]},proxy:true}],null,true)})}):_vm._e()],2)]]})]})],2),_vm._v(" "),_vm._t("footer")],2)};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('gl-base-dropdown',{ref:"baseDropdown",staticClass:"gl-disclosure-dropdown",attrs:{"aria-labelledby":_vm.toggleAriaLabelledBy,"toggle-id":_vm.toggleId,"toggle-text":_vm.toggleText,"toggle-class":_vm.toggleClass,"text-sr-only":_vm.textSrOnly,"category":_vm.category,"variant":_vm.variant,"size":_vm.size,"icon":_vm.icon,"disabled":_vm.disabled,"loading":_vm.loading,"no-caret":_vm.noCaret,"placement":_vm.placement},on:_vm._d({},[_vm.$options.events.GL_DROPDOWN_SHOWN,_vm.onShow,_vm.$options.events.GL_DROPDOWN_HIDDEN,_vm.onHide,_vm.$options.events.GL_DROPDOWN_FOCUS_CONTENT,_vm.onKeydown]),scopedSlots:_vm._u([(_vm.hasCustomToggle)?{key:"toggle",fn:function(){return [_vm._t("toggle")]},proxy:true}:null],null,true)},[_vm._v(" "),_vm._t("header"),_vm._v(" "),_c(_vm.disclosureTag,{ref:"content",tag:"component",staticClass:"gl-new-dropdown-contents",attrs:{"id":_vm.disclosureId,"aria-labelledby":_vm.listAriaLabelledBy || _vm.toggleId,"data-testid":"disclosure-content","tabindex":"-1"},on:{"keydown":_vm.onKeydown}},[_vm._t("default",function(){return [_vm._l((_vm.items),function(item,index){return [(_vm.isItem(item))?[_c('gl-disclosure-dropdown-item',{key:item.text,attrs:{"item":item},on:{"action":_vm.handleAction},scopedSlots:_vm._u([{key:"list-item",fn:function(){return [_vm._t("list-item",null,{"item":item})]},proxy:true}],null,true)})]:[_c('gl-disclosure-dropdown-group',{key:item.name,attrs:{"bordered":index !== 0,"group":item},on:{"action":_vm.handleAction},scopedSlots:_vm._u([(_vm.$scopedSlots['group-label'])?{key:"group-label",fn:function(){return [_vm._t("group-label",null,{"group":item})]},proxy:true}:null],null,true)},[_vm._v(" "),(_vm.$scopedSlots['list-item'])?_vm._l((item.items),function(groupItem){return _c('gl-disclosure-dropdown-item',{key:groupItem.text,attrs:{"item":groupItem},on:{"action":_vm.handleAction},scopedSlots:_vm._u([{key:"list-item",fn:function(){return [_vm._t("list-item",null,{"item":groupItem})]},proxy:true}],null,true)})}):_vm._e()],2)]]})]})],2),_vm._v(" "),_vm._t("footer")],2)};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "58.2.0",
+  "version": "58.2.1",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -83,12 +83,12 @@
   },
   "devDependencies": {
     "@arkweid/lefthook": "0.7.7",
-    "@babel/core": "^7.21.0",
+    "@babel/core": "^7.21.3",
     "@babel/preset-env": "^7.20.2",
     "@gitlab/eslint-plugin": "18.2.0",
     "@gitlab/fonts": "^1.2.0",
     "@gitlab/stylelint-config": "4.1.0",
-    "@gitlab/svgs": "3.24.0",
+    "@gitlab/svgs": "3.26.0",
     "@rollup/plugin-commonjs": "^11.1.0",
     "@rollup/plugin-node-resolve": "^7.1.3",
     "@rollup/plugin-replace": "^2.3.2",

package/src/components/base/new_dropdowns/base_dropdown/base_dropdown.spec.js

@@ -1,6 +1,12 @@
 import { mount } from '@vue/test-utils';
 import { nextTick } from 'vue';
-import { ENTER, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_SHOWN, POPPER_CONFIG } from '../constants';
+import {
+  ARROW_DOWN,
+  GL_DROPDOWN_FOCUS_CONTENT,
+  GL_DROPDOWN_HIDDEN,
+  GL_DROPDOWN_SHOWN,
+  POPPER_CONFIG,
+} from '../constants';
 import GlBaseDropdown from './base_dropdown.vue';
 
 const destroyPopper = jest.fn();
@@ -157,42 +163,50 @@ describe('base dropdown', () => {
     });
   });
 
-  describe('toggle visibility', () => {
+  describe('default toggle', () => {
     beforeEach(() => {
       buildWrapper();
     });
 
-    it('should toggle menu visibility on toggle button click', async () => {
+    it('should open the menu on click but keep focus on toggle', async () => {
       const toggle = findDefaultDropdownToggle();
       const menu = findDropdownMenu();
 
+      toggle.element.focus();
       // open menu clicking toggle btn
       await toggle.trigger('click');
       expect(menu.classes('gl-display-block!')).toBe(true);
       expect(toggle.attributes('aria-expanded')).toBe('true');
-      await nextTick();
-      expect(wrapper.emitted(GL_DROPDOWN_SHOWN).length).toBe(1);
+      expect(toggle.element).toHaveFocus();
 
-      // close menu clicking toggle btn again
+      // close menu clicking toggle btn
       await toggle.trigger('click');
       expect(menu.classes('gl-display-block!')).toBe(false);
       expect(toggle.attributes('aria-expanded')).toBeUndefined();
-      expect(wrapper.emitted(GL_DROPDOWN_HIDDEN).length).toBe(1);
+      expect(wrapper.emitted(GL_DROPDOWN_HIDDEN)).toHaveLength(1);
+      expect(toggle.element).toHaveFocus();
+    });
+
+    it('should emit `GL_DROPDOWN_FOCUS_CONTENT` event on `ARROW_DOWN`', () => {
+      findDefaultDropdownToggle().trigger('keydown', { code: ARROW_DOWN });
+      expect(wrapper.emitted(GL_DROPDOWN_FOCUS_CONTENT)).toHaveLength(1);
     });
 
-    it('should close the menu when Escape is pressed inside menu and focus toggle', async () => {
+    it('should close menu on Escape and focus toggle', async () => {
       const toggle = findDefaultDropdownToggle();
       const menu = findDropdownMenu();
 
       // open menu clicking toggle btn
       await toggle.trigger('click');
       expect(menu.classes('gl-display-block!')).toBe(true);
+      expect(toggle.attributes('aria-expanded')).toBe('true');
 
-      // close menu pressing ESC on it
+      // close menu clicking toggle btn
+      menu.element.focus();
       await menu.trigger('keydown.esc');
       expect(menu.classes('gl-display-block!')).toBe(false);
       expect(toggle.attributes('aria-expanded')).toBeUndefined();
-      expect(wrapper.emitted(GL_DROPDOWN_HIDDEN).length).toBe(1);
+      expect(wrapper.emitted(GL_DROPDOWN_HIDDEN)).toHaveLength(1);
       expect(toggle.element).toHaveFocus();
     });
   });
@@ -221,22 +235,22 @@ describe('base dropdown', () => {
     });
 
     describe('toggle visibility', () => {
-      it('should toggle menu visibility on toggle button ENTER', async () => {
+      it('should toggle menu visibility on toggle click', async () => {
         const toggle = findCustomDropdownToggle();
         const firstToggleChild = findFirstToggleElement();
         const menu = findDropdownMenu();
         // open menu clicking toggle btn
-        await toggle.trigger('keydown', { code: ENTER });
+        await toggle.trigger('click');
         expect(menu.classes('gl-display-block!')).toBe(true);
         expect(firstToggleChild.attributes('aria-expanded')).toBe('true');
         await nextTick();
-        expect(wrapper.emitted(GL_DROPDOWN_SHOWN).length).toBe(1);
+        expect(wrapper.emitted(GL_DROPDOWN_SHOWN)).toHaveLength(1);
 
         // close menu clicking toggle btn again
-        await toggle.trigger('keydown', { code: ENTER });
+        await toggle.trigger('click');
         expect(menu.classes('gl-display-block!')).toBe(false);
         expect(firstToggleChild.attributes('aria-expanded')).toBe('false');
-        expect(wrapper.emitted(GL_DROPDOWN_HIDDEN).length).toBe(1);
+        expect(wrapper.emitted(GL_DROPDOWN_HIDDEN)).toHaveLength(1);
       });
 
       it('should close the menu when Escape is pressed inside menu and focus first child in the toggle', async () => {
@@ -251,9 +265,15 @@ describe('base dropdown', () => {
         await menu.trigger('keydown.esc');
         expect(menu.classes('gl-display-block!')).toBe(false);
         expect(firstToggleChild.attributes('aria-expanded')).toBe('false');
-        expect(wrapper.emitted(GL_DROPDOWN_HIDDEN).length).toBe(1);
+        expect(wrapper.emitted(GL_DROPDOWN_HIDDEN)).toHaveLength(1);
         expect(toggle.find(`[data-testid="${customToggleTestId}"]`).element).toHaveFocus();
       });
     });
+
+    it('should emit `GL_DROPDOWN_FOCUS_CONTENT` event on `ARROW_DOWN`', () => {
+      const toggle = findCustomDropdownToggle();
+      toggle.trigger('keydown', { code: ARROW_DOWN });
+      expect(wrapper.emitted(GL_DROPDOWN_FOCUS_CONTENT)).toHaveLength(1);
+    });
   });
 });

package/src/components/base/new_dropdowns/base_dropdown/base_dropdown.vue

@@ -7,7 +7,15 @@ import {
   dropdownPlacements,
   dropdownVariantOptions,
 } from '../../../../utils/constants';
-import { POPPER_CONFIG, GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, ENTER, SPACE } from '../constants';
+import {
+  POPPER_CONFIG,
+  GL_DROPDOWN_SHOWN,
+  GL_DROPDOWN_HIDDEN,
+  GL_DROPDOWN_FOCUS_CONTENT,
+  ENTER,
+  SPACE,
+  ARROW_DOWN,
+} from '../constants';
 import { logWarning, isElementTabbable, isElementFocusable } from '../../../../utils/utils';
 
 import GlButton from '../../button/button.vue';
@@ -162,6 +170,7 @@ export default {
           class: this.toggleButtonClasses,
           ...this.ariaAttributes,
           listeners: {
+            keydown: (event) => this.onKeydown(event),
             click: () => this.toggle(),
           },
         };
@@ -260,11 +269,28 @@ export default {
       this.toggleElement.focus();
     },
     onKeydown(event) {
-      const { code } = event;
+      const {
+        code,
+        target: { tagName },
+      } = event;
+
+      let toggleOnEnter = true;
+      let toggleOnSpace = true;
+
+      if (tagName === 'BUTTON') {
+        toggleOnEnter = false;
+        toggleOnSpace = false;
+      } else if (tagName === 'A') {
+        toggleOnEnter = false;
+      }
 
-      if (code === ENTER || code === SPACE) {
+      if ((code === ENTER && toggleOnEnter) || (code === SPACE && toggleOnSpace)) {
         this.toggle();
       }
+
+      if (code === ARROW_DOWN) {
+        this.$emit(GL_DROPDOWN_FOCUS_CONTENT, event);
+      }
     },
   },
 };

package/src/components/base/new_dropdowns/constants.js

@@ -12,6 +12,7 @@ export const POPPER_CONFIG = {
 // base dropdown events
 export const GL_DROPDOWN_SHOWN = 'shown';
 export const GL_DROPDOWN_HIDDEN = 'hidden';
+export const GL_DROPDOWN_FOCUS_CONTENT = 'focusContent';
 
 // KEY Codes
 export const ARROW_DOWN = 'ArrowDown';

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.spec.js

@@ -4,6 +4,7 @@ import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
 import {
   GL_DROPDOWN_SHOWN,
   GL_DROPDOWN_HIDDEN,
+  GL_DROPDOWN_FOCUS_CONTENT,
   ARROW_DOWN,
   ARROW_UP,
   HOME,
@@ -82,10 +83,6 @@ describe('GlDisclosureDropdown', () => {
     it('should re-emit the event', () => {
       expect(wrapper.emitted(GL_DROPDOWN_SHOWN)).toHaveLength(1);
     });
-
-    it('should focus the first item', () => {
-      expect(findDisclosureItems().at(0).find(ITEM_SELECTOR).element).toHaveFocus();
-    });
   });
 
   describe('onHide', () => {
@@ -112,7 +109,11 @@ describe('GlDisclosureDropdown', () => {
       thirdItem = findListItem(2);
     });
 
-    it('should move the focus down the list of items on `ARROW_DOWN` and stop on the last item', async () => {
+    it('should move the focus from toggle and down the list of items on `ARROW_DOWN` and stop on the last item', async () => {
+      findBaseDropdown().vm.$emit(
+        GL_DROPDOWN_FOCUS_CONTENT,
+        new KeyboardEvent('keydown', { code: ARROW_DOWN })
+      );
       expect(firstItem.element).toHaveFocus();
       await firstItem.trigger('keydown', { code: ARROW_DOWN });
       expect(secondItem.element).toHaveFocus();
@@ -135,6 +136,10 @@ describe('GlDisclosureDropdown', () => {
     });
 
     it('should move focus to the last item on `END` keydown', async () => {
+      findBaseDropdown().vm.$emit(
+        GL_DROPDOWN_FOCUS_CONTENT,
+        new KeyboardEvent('keydown', { code: ARROW_DOWN })
+      );
       expect(firstItem.element).toHaveFocus();
       await firstItem.trigger('keydown', { code: END });
       expect(thirdItem.element).toHaveFocus();
@@ -158,6 +163,10 @@ describe('GlDisclosureDropdown', () => {
       });
 
       it('should skip over it', async () => {
+        findBaseDropdown().vm.$emit(
+          GL_DROPDOWN_FOCUS_CONTENT,
+          new KeyboardEvent('keydown', { code: ARROW_DOWN })
+        );
         expect(firstItem.element).toHaveFocus();
         await firstItem.trigger('keydown', { code: ARROW_DOWN });
 

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.vue

@@ -6,6 +6,7 @@ import { stopEvent, filterVisible } from '../../../../utils/utils';
 import {
   GL_DROPDOWN_SHOWN,
   GL_DROPDOWN_HIDDEN,
+  GL_DROPDOWN_FOCUS_CONTENT,
   HOME,
   END,
   ARROW_DOWN,
@@ -26,6 +27,7 @@ export default {
   events: {
     GL_DROPDOWN_SHOWN,
     GL_DROPDOWN_HIDDEN,
+    GL_DROPDOWN_FOCUS_CONTENT,
   },
   components: {
     GlBaseDropdown,
@@ -188,12 +190,6 @@ export default {
       this.$refs.baseDropdown.close();
     },
     onShow() {
-      const items = this.getFocusableListItemElements();
-
-      if (items.length) {
-        this.focusItem(0, items);
-      }
-
       /**
        * Emitted when dropdown is shown
        *
@@ -285,6 +281,7 @@ export default {
     class="gl-disclosure-dropdown"
     @[$options.events.GL_DROPDOWN_SHOWN]="onShow"
     @[$options.events.GL_DROPDOWN_HIDDEN]="onHide"
+    @[$options.events.GL_DROPDOWN_FOCUS_CONTENT]="onKeydown"
   >
     <template v-if="hasCustomToggle" #toggle>
       <!-- @slot Custom toggle content -->