@gitlab/ui 54.3.0 → 54.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [54.4.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v54.3.0...v54.4.0) (2023-02-02)
+
+
+### Features
+
+* **GlDisclosureDropdown:** Add support for item wrapper class ([8b575af](https://gitlab.com/gitlab-org/gitlab-ui/commit/8b575af03dcdeb9206ef3caf65f2519b9628b1ae))
+
 # [54.3.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v54.2.3...v54.3.0) (2023-02-02)
 
 

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

@@ -1,6 +1,6 @@
 import _uniqueId from 'lodash/uniqueId';
 import _clamp from 'lodash/clamp';
-import { stopEvent } from '../../../../utils/utils';
+import { stopEvent, filterVisible } from '../../../../utils/utils';
 import { GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, HOME, END, ARROW_UP, ARROW_DOWN } from '../constants';
 import { buttonCategoryOptions, dropdownVariantOptions, buttonSizeOptions, dropdownPlacements } from '../../../../utils/constants';
 import GlBaseDropdown from '../base_dropdown/base_dropdown';
@@ -104,7 +104,7 @@ var script = {
     toggleId: {
       type: String,
       required: false,
-      default: () => _uniqueId('dropdown-toggle-btn-')
+      default: _uniqueId('dropdown-toggle-btn-')
     },
     /**
      * Additional CSS classes to customize toggle appearance
@@ -231,7 +231,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}`);
-      return Array.from(items || []);
+      return filterVisible(Array.from(items || []));
     },
     focusNextItem(event, elements, offset) {
       const {

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

@@ -26,12 +26,14 @@ var script = {
       const {
         item
       } = this;
+      if (!item) return null;
       if (this.isLink) return {
         is: 'a',
         attrs: {
           href: item.href,
           ...item.extraAttrs
         },
+        wrapperClass: item.wrapperClass,
         listeners: {}
       };
       return {
@@ -45,7 +47,8 @@ var script = {
             var _item$action;
             return (_item$action = item.action) === null || _item$action === void 0 ? void 0 : _item$action.call(undefined, item);
           }
-        }
+        },
+        wrapperClass: item.wrapperClass
       };
     }
   },
@@ -78,7 +81,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('li',{staticClass:"gl-new-dropdown-item",class:_vm.$options.ITEM_CLASS,attrs:{"tabindex":"0","data-testid":"disclosure-dropdown-item"},on:{"click":_vm.action,"keydown":_vm.onKeydown}},[(_vm.isCustomContent)?_c('div',{staticClass:"gl-new-dropdown-item-content"},[_c('div',{staticClass:"gl-new-dropdown-item-text-wrapper"},[_vm._t("default")],2)]):[_c(_vm.itemComponent.is,_vm._g(_vm._b({ref:"item",tag:"component",staticClass:"gl-new-dropdown-item-content",attrs:{"tabindex":"-1"}},'component',_vm.itemComponent.attrs,false),_vm.itemComponent.listeners),[_c('span',{staticClass:"gl-new-dropdown-item-text-wrapper"},[_vm._v("\n        "+_vm._s(_vm.item.text)+"\n      ")])])]],2)};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('li',{class:[_vm.$options.ITEM_CLASS, _vm.itemComponent && _vm.itemComponent.wrapperClass],attrs:{"tabindex":"0","data-testid":"disclosure-dropdown-item"},on:{"click":_vm.action,"keydown":_vm.onKeydown}},[(_vm.isCustomContent)?_c('div',{staticClass:"gl-new-dropdown-item-content"},[_c('div',{staticClass:"gl-new-dropdown-item-text-wrapper"},[_vm._t("default")],2)]):(_vm.itemComponent && _vm.item)?[_c(_vm.itemComponent.is,_vm._g(_vm._b({ref:"item",tag:"component",staticClass:"gl-new-dropdown-item-content",attrs:{"tabindex":"-1"}},'component',_vm.itemComponent.attrs,false),_vm.itemComponent.listeners),[_c('span',{staticClass:"gl-new-dropdown-item-text-wrapper"},[_vm._v("\n        "+_vm._s(_vm.item.text)+"\n      ")])])]:_vm._e()],2)};
 var __vue_staticRenderFns__ = [];
 
   /* style */

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

@@ -41,6 +41,13 @@ const mockItemsCustomItem = [{
     target: '_blank',
     rel: 'nofollow'
   }
+}, {
+  text: 'I am only visible on mobile!',
+  action: () => {
+    // eslint-disable-next-line no-console
+    console.log('clicked!');
+  },
+  wrapperClass: 'gl-sm-display-none!'
 }];
 const mockGroupsCustomItem = [{
   name: 'Merge requests',

package/dist/utils/utils.js

@@ -1,3 +1,4 @@
+import { isVisible } from 'bootstrap-vue/esm/utils/dom';
 import { COMMA, labelColorOptions, focusableTags } from './constants';
 
 function debounceByAnimationFrame(fn) {
@@ -134,4 +135,11 @@ function stopEvent(event) {
   }
 }
 
-export { colorFromBackground, debounceByAnimationFrame, focusFirstFocusableElement, hexToRgba, isDev, isElementFocusable, logWarning, rgbFromHex, rgbFromString, stopEvent, throttle, uid };
+/**
+ * Return an Array of visible items
+ */
+function filterVisible(els) {
+  return (els || []).filter(isVisible);
+}
+
+export { colorFromBackground, debounceByAnimationFrame, filterVisible, focusFirstFocusableElement, hexToRgba, isDev, isElementFocusable, logWarning, rgbFromHex, rgbFromString, stopEvent, throttle, uid };

package/package.json

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

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

@@ -5,10 +5,7 @@ to make sure this is the right dropdown component for you.
 ### Basic usage
 
 ```html
-<gl-disclosure-dropdown-dropdown
-  toggle-text="Actions"
-  :items="items"
-/>
+<gl-disclosure-dropdown-dropdown toggle-text="Actions" :items="items" />
 ```
 
 ### Icon-only disclosure dropdown
@@ -58,17 +55,28 @@ Below are the expected shapes of these objects:
 
 ```typescript
 type Item = {
-  text: string
-  href?: string,
-  action?: (item: Item) => void,
-}
+  // The item text
+  text: string;
+  // href link
+  href?: string;
+  // Item action
+  action?: (item: Item) => void;
+  // Set of extra attributes applied directly to the element
+  extraAttrs?: Object;
+  // Additional class/classes applied to the item wrapper
+  wrapperClass?: string;
+};
 
 type Group = {
-  name?: string
-  items: Array<Item>
-}
-
-type ItemsProp = Array<Item> | Array<Group>
+  // Name of the group, used as a header
+  name?: string;
+  // Items of the group
+  items: Array<Item>;
+  // Set of extra attributes applied directly to the element
+  extraAttrs?: Object;
+};
+
+type ItemsProp = Array<Item> | Array<Group>;
 ```
 
 #### Actions/links

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

@@ -1,4 +1,5 @@
 import { mount } from '@vue/test-utils';
+import * as utils from '../../../../utils/utils';
 import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
 import {
   GL_DROPDOWN_SHOWN,
@@ -32,6 +33,8 @@ describe('GlDisclosureDropdown', () => {
   const findDisclosureGroups = () => wrapper.findAllComponents(GlDisclosureDropdownGroup);
   const findListItem = (index) => findDisclosureItems().at(index).findComponent(ITEM_SELECTOR);
 
+  jest.spyOn(utils, 'filterVisible').mockImplementation((items) => items);
+
   describe('toggle text', () => {
     it('should pass toggle text to the base dropdown', () => {
       const toggleText = 'Merge requests';
@@ -147,6 +150,23 @@ describe('GlDisclosureDropdown', () => {
       await thirdItem.trigger('keydown', { code: HOME });
       expect(firstItem.element).toHaveFocus();
     });
+
+    describe('when an element is hidden', () => {
+      beforeEach(() => {
+        jest.spyOn(utils, 'filterVisible').mockReturnValue([firstItem.element, thirdItem.element]);
+      });
+
+      it('should skip over it', async () => {
+        expect(firstItem.element).toHaveFocus();
+        await firstItem.trigger('keydown', { code: ARROW_DOWN });
+
+        expect(secondItem.element).not.toHaveFocus();
+        expect(thirdItem.element).toHaveFocus();
+
+        await thirdItem.trigger('keydown', { code: ARROW_UP });
+        expect(firstItem.element).toHaveFocus();
+      });
+    });
   });
 
   describe('slot content', () => {

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

@@ -1,7 +1,7 @@
 <!-- eslint-disable vue/multi-word-component-names -->
 <script>
 import { clamp, uniqueId } from 'lodash';
-import { stopEvent } from '../../../../utils/utils';
+import { stopEvent, filterVisible } from '../../../../utils/utils';
 import {
   GL_DROPDOWN_SHOWN,
   GL_DROPDOWN_HIDDEN,
@@ -116,7 +116,7 @@ export default {
     toggleId: {
       type: String,
       required: false,
-      default: () => uniqueId('dropdown-toggle-btn-'),
+      default: uniqueId('dropdown-toggle-btn-'),
     },
     /**
      * Additional CSS classes to customize toggle appearance
@@ -246,7 +246,7 @@ export default {
     },
     getFocusableListItemElements() {
       const items = this.$refs.content?.querySelectorAll(`.${ITEM_CLASS}`);
-      return Array.from(items || []);
+      return filterVisible(Array.from(items || []));
     },
     focusNextItem(event, elements, offset) {
       const { target } = event;

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

@@ -56,6 +56,26 @@ describe('GlDisclosureDropdownItem', () => {
       expect(findLink().attributes('href')).toBe(mockItems[0].href);
       expect(findLink().attributes()).toMatchObject(mockItems[0].extraAttrs);
     });
+
+    it('should apply the default classes to the item wrapper', () => {
+      expect(findItem().classes()).toEqual(['gl-new-dropdown-item']);
+    });
+
+    describe('when item has wrapperClass', () => {
+      const TEST_CLASS = 'just-a-test-class';
+      beforeEach(() => {
+        buildWrapper({
+          item: {
+            ...mockItems[0],
+            wrapperClass: TEST_CLASS,
+          },
+        });
+      });
+
+      it('should add the extra class to the item wrapper', () => {
+        expect(findItem().classes()).toContain(TEST_CLASS);
+      });
+    });
   });
 
   describe('when item has an `action`', () => {
@@ -102,5 +122,35 @@ describe('GlDisclosureDropdownItem', () => {
       trigger();
       expect(wrapper.emitted('action')).toEqual([[item]]);
     });
+
+    it('should apply the default classes to the item wrapper', () => {
+      expect(findItem().classes()).toEqual(['gl-new-dropdown-item']);
+    });
+
+    describe('when item has wrapperClass', () => {
+      const TEST_CLASS = 'just-a-test-class';
+      beforeEach(() => {
+        buildWrapper({
+          item: {
+            ...mockItems[1],
+            wrapperClass: TEST_CLASS,
+          },
+        });
+      });
+
+      it('should add the extra class to the item wrapper', () => {
+        expect(findItem().classes()).toContain(TEST_CLASS);
+      });
+    });
+  });
+
+  describe('when item is null', () => {
+    beforeEach(() => {
+      buildWrapper({ item: null });
+    });
+
+    it('should not render anything', () => {
+      expect(wrapper.text()).toBe('');
+    });
   });
 });

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

@@ -25,6 +25,8 @@ export default {
     itemComponent() {
       const { item } = this;
 
+      if (!item) return null;
+
       if (this.isLink)
         return {
           is: 'a',
@@ -32,6 +34,7 @@ export default {
             href: item.href,
             ...item.extraAttrs,
           },
+          wrapperClass: item.wrapperClass,
           listeners: {},
         };
 
@@ -44,6 +47,7 @@ export default {
         listeners: {
           click: () => item.action?.call(undefined, item),
         },
+        wrapperClass: item.wrapperClass,
       };
     },
   },
@@ -72,8 +76,7 @@ export default {
 <template>
   <li
     tabindex="0"
-    :class="$options.ITEM_CLASS"
-    class="gl-new-dropdown-item"
+    :class="[$options.ITEM_CLASS, itemComponent && itemComponent.wrapperClass]"
     data-testid="disclosure-dropdown-item"
     @click="action"
     @keydown="onKeydown"
@@ -84,7 +87,7 @@ export default {
       </div>
     </div>
 
-    <template v-else>
+    <template v-else-if="itemComponent && item">
       <component
         :is="itemComponent.is"
         v-bind="itemComponent.attrs"

package/src/components/base/new_dropdowns/disclosure/mock_data.js

@@ -49,6 +49,14 @@ export const mockItemsCustomItem = [
       rel: 'nofollow',
     },
   },
+  {
+    text: 'I am only visible on mobile!',
+    action: () => {
+      // eslint-disable-next-line no-console
+      console.log('clicked!');
+    },
+    wrapperClass: 'gl-sm-display-none!',
+  },
 ];
 
 export const mockGroupsCustomItem = [

package/src/utils/utils.js

@@ -1,3 +1,4 @@
+import { isVisible } from 'bootstrap-vue/src/utils/dom';
 import { COMMA, labelColorOptions, focusableTags } from './constants';
 
 export function debounceByAnimationFrame(fn) {
@@ -140,3 +141,10 @@ export function stopEvent(
     event.stopImmediatePropagation();
   }
 }
+
+/**
+ * Return an Array of visible items
+ */
+export function filterVisible(els) {
+  return (els || []).filter(isVisible);
+}