@gitlab/ui 62.10.0 → 62.11.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [62.11.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v62.10.0...v62.11.0) (2023-05-12)
+
+
+### Features
+
+* **GlDisclosureDropdown:** Close the disclosure dropdown on item click ([f4c2208](https://gitlab.com/gitlab-org/gitlab-ui/commit/f4c2208af8f11b5aa96faa6bdb88898f67b4edcc))
+
 # [62.10.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v62.9.3...v62.10.0) (2023-05-11)
 
 

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, GL_DROPDOWN_FOCUS_CONTENT, 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, ENTER, SPACE } 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';
@@ -10,6 +10,7 @@ import { itemsValidator, hasOnlyListItems, isItem } from './utils';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 //
+const ITEM_SELECTOR = `.${ITEM_CLASS}`;
 var script = {
   name: 'GlDisclosureDropdown',
   events: {
@@ -169,6 +170,14 @@ var script = {
       type: Boolean,
       required: false,
       default: false
+    },
+    /**
+     * Close the dropdown on item click (action)
+     */
+    autoClose: {
+      type: Boolean,
+      required: false,
+      default: true
     }
   },
   data() {
@@ -228,6 +237,8 @@ var script = {
         this.focusNextItem(event, elements, -1);
       } else if (code === ARROW_DOWN) {
         this.focusNextItem(event, elements, 1);
+      } else if (code === ENTER || code === SPACE) {
+        this.handleAutoClose(event);
       } else {
         stop = false;
       }
@@ -237,7 +248,7 @@ var script = {
     },
     getFocusableListItemElements() {
       var _this$$refs$content;
-      const items = (_this$$refs$content = this.$refs.content) === null || _this$$refs$content === void 0 ? void 0 : _this$$refs$content.querySelectorAll(`.${ITEM_CLASS}`);
+      const items = (_this$$refs$content = this.$refs.content) === null || _this$$refs$content === void 0 ? void 0 : _this$$refs$content.querySelectorAll(ITEM_SELECTOR);
       return filterVisible(Array.from(items || []));
     },
     focusNextItem(event, elements, offset) {
@@ -264,6 +275,11 @@ var script = {
        */
       this.$emit('action', action);
     },
+    handleAutoClose(e) {
+      if (this.autoClose && e.target.closest(ITEM_SELECTOR)) {
+        this.closeAndFocus();
+      }
+    },
     uniqueItemId() {
       return uniqueId(`disclosure-item-`);
     },
@@ -275,7 +291,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,"popper-options":_vm.popperOptions,"fluid-width":_vm.fluidWidth},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:_vm.uniqueItemId(),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:_vm.uniqueItemId(),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,"popper-options":_vm.popperOptions,"fluid-width":_vm.fluidWidth},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,"click":_vm.handleAutoClose}},[_vm._t("default",function(){return [_vm._l((_vm.items),function(item,index){return [(_vm.isItem(item))?[_c('gl-disclosure-dropdown-item',{key:_vm.uniqueItemId(),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:_vm.uniqueItemId(),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 */
@@ -308,3 +324,4 @@ var __vue_staticRenderFns__ = [];
   );
 
 export default __vue_component__;
+export { ITEM_SELECTOR };

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

@@ -79,11 +79,11 @@ var script = {
         code
       } = event;
       if (code === ENTER || code === SPACE) {
-        stopEvent(event);
         if (this.isCustomContent) {
           this.action();
         } else {
           var _this$$refs$item;
+          stopEvent(event);
           /** Instead of simply navigating or calling the action, we want
            * the `a/button` to be the target of the event as it might have additional attributes.
            * E.g. `a` might have `target` attribute.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "62.10.0",
+  "version": "62.11.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -89,7 +89,7 @@
     "@gitlab/eslint-plugin": "19.0.0",
     "@gitlab/fonts": "^1.2.0",
     "@gitlab/stylelint-config": "4.1.0",
-    "@gitlab/svgs": "3.44.0",
+    "@gitlab/svgs": "3.45.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/disclosure/disclosure_dropdown.md

@@ -36,6 +36,7 @@ The disclosure dropdown is closed by any of the following:
 
 - pressing <kbd>Esc</kbd>
 - clicking anywhere outside the component
+- clicking the action or link inside the dropdown
 
 After closing, `GlDisclosureDropdown` emits a `hidden` event.
 

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

@@ -323,4 +323,20 @@ describe('GlDisclosureDropdown', () => {
       expect(findBaseDropdown().props('fluidWidth')).toBe(true);
     });
   });
+
+  describe('auto closing', () => {
+    it('closes the dropdown when `autoClose` is set on item click', () => {
+      buildWrapper({ items: mockItems });
+      const closeSpy = jest.spyOn(wrapper.vm.$refs.baseDropdown, 'closeAndFocus');
+      findListItem(0).trigger('click');
+      expect(closeSpy).toHaveBeenCalled();
+    });
+
+    it('does not close the dropdown  on item click when `autoClose` is set to `false`', () => {
+      buildWrapper({ items: mockItems, autoClose: false });
+      const closeSpy = jest.spyOn(wrapper.vm.$refs.baseDropdown, 'closeAndFocus');
+      findListItem(0).trigger('click');
+      expect(closeSpy).not.toHaveBeenCalled();
+    });
+  });
 });

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

@@ -40,6 +40,7 @@ const makeBindings = (overrides = {}) =>
     ':toggle-aria-labelled-by': 'toggleAriaLabelledBy',
     ':list-aria-labelled-by': 'listAriaLabelledBy',
     ':fluid-width': 'fluidWidth',
+    ':auto-close': 'autoClose',
     ...overrides,
   })
     .map(([key, value]) => `${key}="${value}"`)
@@ -216,7 +217,7 @@ export const CustomGroupsItemsAndToggle = makeGroupedExample({
       </button>
       </template>
       <gl-disclosure-dropdown-group>
-        <gl-disclosure-dropdown-item>
+        <gl-disclosure-dropdown-item @action="closeDropdown">
           <template #list-item>
             <span class="gl-display-flex gl-flex-direction-column">
               <span class="gl-font-weight-bold gl-white-space-nowrap">Orange Fox</span>
@@ -225,7 +226,7 @@ export const CustomGroupsItemsAndToggle = makeGroupedExample({
           </template>
         </gl-disclosure-dropdown-item>
       </gl-disclosure-dropdown-group>
-      <gl-disclosure-dropdown-group bordered :group="$options.groups[0]">
+      <gl-disclosure-dropdown-group bordered :group="$options.groups[0]" @action="closeDropdown">
         <template #list-item="{ item }">
           <span class="gl-display-flex gl-align-items-center gl-justify-content-space-between">
             {{item.text}}
@@ -249,7 +250,7 @@ export const CustomGroupsItemsAndToggle = makeGroupedExample({
           <template #list-item>Provide feedback</template>
         </gl-disclosure-dropdown-item>
       </gl-disclosure-dropdown-group>
-      <gl-disclosure-dropdown-group bordered :group="$options.groups[1]"/>
+      <gl-disclosure-dropdown-group bordered :group="$options.groups[1]" @action="closeDropdown"/>
     `,
     {
       after: `
@@ -266,11 +267,19 @@ export const CustomGroupsItemsAndToggle = makeGroupedExample({
     };
   },
   methods: {
+    closeDropdown() {
+      this.$refs.disclosure.closeAndFocus();
+    },
     toggleModalVisibility(value) {
       this.feedBackModalVisible = value;
+      this.closeDropdown();
     },
     toggleNewNavigation() {
       this.newNavigation = !this.newNavigation;
+      // eslint-disable-next-line no-restricted-globals
+      setTimeout(() => {
+        this.closeDropdown();
+      }, 500);
     },
   },
   groups: mockProfileGroups,
@@ -279,6 +288,7 @@ CustomGroupsItemsAndToggle.args = {
   icon: 'plus-square',
   toggleText: 'User profile menu',
   textSrOnly: true,
+  autoClose: false,
 };
 CustomGroupsItemsAndToggle.decorators = [makeContainer({ height: '400px' })];
 

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

@@ -7,6 +7,8 @@ import {
   GL_DROPDOWN_SHOWN,
   GL_DROPDOWN_HIDDEN,
   GL_DROPDOWN_FOCUS_CONTENT,
+  ENTER,
+  SPACE,
   HOME,
   END,
   ARROW_DOWN,
@@ -23,6 +25,8 @@ import GlDisclosureDropdownItem, { ITEM_CLASS } from './disclosure_dropdown_item
 import GlDisclosureDropdownGroup from './disclosure_dropdown_group.vue';
 import { itemsValidator, isItem, hasOnlyListItems } from './utils';
 
+export const ITEM_SELECTOR = `.${ITEM_CLASS}`;
+
 export default {
   name: 'GlDisclosureDropdown',
   events: {
@@ -183,6 +187,14 @@ export default {
       required: false,
       default: false,
     },
+    /**
+     * Close the dropdown on item click (action)
+     */
+    autoClose: {
+      type: Boolean,
+      required: false,
+      default: true,
+    },
   },
   data() {
     return {
@@ -241,6 +253,8 @@ export default {
         this.focusNextItem(event, elements, -1);
       } else if (code === ARROW_DOWN) {
         this.focusNextItem(event, elements, 1);
+      } else if (code === ENTER || code === SPACE) {
+        this.handleAutoClose(event);
       } else {
         stop = false;
       }
@@ -250,7 +264,7 @@ export default {
       }
     },
     getFocusableListItemElements() {
-      const items = this.$refs.content?.querySelectorAll(`.${ITEM_CLASS}`);
+      const items = this.$refs.content?.querySelectorAll(ITEM_SELECTOR);
       return filterVisible(Array.from(items || []));
     },
     focusNextItem(event, elements, offset) {
@@ -276,6 +290,11 @@ export default {
        */
       this.$emit('action', action);
     },
+    handleAutoClose(e) {
+      if (this.autoClose && e.target.closest(ITEM_SELECTOR)) {
+        this.closeAndFocus();
+      }
+    },
     uniqueItemId() {
       return uniqueId(`disclosure-item-`);
     },
@@ -324,6 +343,7 @@ export default {
       class="gl-new-dropdown-contents"
       tabindex="-1"
       @keydown="onKeydown"
+      @click="handleAutoClose"
     >
       <slot>
         <template v-for="(item, index) in items">

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

@@ -76,11 +76,10 @@ export default {
       const { code } = event;
 
       if (code === ENTER || code === SPACE) {
-        stopEvent(event);
-
         if (this.isCustomContent) {
           this.action();
         } else {
+          stopEvent(event);
           /** Instead of simply navigating or calling the action, we want
            * the `a/button` to be the target of the event as it might have additional attributes.
            * E.g. `a` might have `target` attribute.