@gitlab/ui 52.10.0 → 52.12.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [52.12.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v52.11.0...v52.12.0) (2023-01-17)
+
+
+### Features
+
+* **GlEmptyState:** Add content-class prop ([7f850d7](https://gitlab.com/gitlab-org/gitlab-ui/commit/7f850d7661ffcb6a2db1cccfaca87cd7d794e01b))
+
+# [52.11.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v52.10.0...v52.11.0) (2023-01-16)
+
+
+### Features
+
+* **GlDisclosureDropdown:** Add GlDisclosureDropdown component ([e9bca59](https://gitlab.com/gitlab-org/gitlab-ui/commit/e9bca595b591846e892991611ea92f51fd4db055))
+
 # [52.10.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v52.9.3...v52.10.0) (2023-01-10)
 
 

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

@@ -1,6 +1,7 @@
+import _uniqueId from 'lodash/uniqueId';
 import { createPopper } from '@popperjs/core';
 import { buttonCategoryOptions, dropdownVariantOptions, buttonSizeOptions } from '../../../../utils/constants';
-import { POPPER_CONFIG, GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN } from '../constants';
+import { POPPER_CONFIG, GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, ENTER, SPACE } from '../constants';
 import GlButton from '../../button/button';
 import GlIcon from '../../icon/icon';
 import { OutsideDirective } from '../../../../directives/outside/outside';
@@ -103,7 +104,8 @@ var script = {
   },
   data() {
     return {
-      visible: false
+      visible: false,
+      baseDropdownId: _uniqueId('base-dropdown-')
     };
   },
   computed: {
@@ -140,13 +142,21 @@ var script = {
           size: this.size,
           disabled: this.disabled,
           loading: this.loading,
-          class: this.toggleButtonClasses
+          class: this.toggleButtonClasses,
+          listeners: {
+            click: () => this.toggle()
+          }
         };
       }
       return {
         is: 'div',
+        role: 'button',
         class: 'gl-dropdown-custom-toggle gl-hover-cursor-pointer',
-        tabindex: '0'
+        tabindex: '0',
+        listeners: {
+          keydown: event => this.onKeydown(event),
+          click: () => this.toggle()
+        }
       };
     },
     toggleElement() {
@@ -210,6 +220,14 @@ var script = {
     },
     focusToggle() {
       this.toggleElement.focus();
+    },
+    onKeydown(event) {
+      const {
+        code
+      } = event;
+      if (code === ENTER || code === SPACE) {
+        this.toggle();
+      }
     }
   }
 };
@@ -218,7 +236,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('div',{directives:[{name:"outside",rawName:"v-outside",value:(_vm.close),expression:"close"}],staticClass:"gl-dropdown dropdown gl-display-inline-flex gl-vertical-align-middle"},[_c(_vm.toggleOptions.is,_vm._b({ref:"toggle",tag:"component",attrs:{"id":_vm.toggleId,"data-testid":"base-dropdown-toggle","aria-haspopup":_vm.ariaHaspopup,"aria-expanded":_vm.visible,"aria-labelledby":_vm.toggleLabelledBy},on:{"keydown":function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"enter",13,$event.key,"Enter")){ return null; }return _vm.toggle.apply(null, arguments)},"click":_vm.toggle}},'component',_vm.toggleOptions,false),[_vm._t("toggle",function(){return [_c('span',{staticClass:"gl-dropdown-button-text",class:{ 'gl-sr-only': _vm.textSrOnly }},[_vm._v("\n        "+_vm._s(_vm.toggleText)+"\n      ")]),_vm._v(" "),(!_vm.noCaret)?_c('gl-icon',{staticClass:"gl-button-icon dropdown-chevron",attrs:{"name":"chevron-down"}}):_vm._e()]})],2),_vm._v(" "),_c('div',{ref:"content",staticClass:"dropdown-menu",class:{ show: _vm.visible },attrs:{"data-testid":"base-dropdown-menu"},on:{"keydown":function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"esc",27,$event.key,["Esc","Escape"])){ return null; }$event.stopPropagation();$event.preventDefault();return _vm.closeAndFocus.apply(null, arguments)}}},[_c('div',{staticClass:"gl-dropdown-inner"},[_vm._t("default")],2)])],1)};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{directives:[{name:"outside",rawName:"v-outside",value:(_vm.close),expression:"close"}],staticClass:"gl-dropdown dropdown gl-display-inline-flex gl-vertical-align-middle"},[_c(_vm.toggleOptions.is,_vm._g(_vm._b({ref:"toggle",tag:"component",attrs:{"id":_vm.toggleId,"data-testid":"base-dropdown-toggle","aria-haspopup":_vm.ariaHaspopup,"aria-expanded":_vm.visible,"aria-labelledby":_vm.toggleLabelledBy,"aria-controls":_vm.baseDropdownId}},'component',_vm.toggleOptions,false),_vm.toggleOptions.listeners),[_vm._t("toggle",function(){return [_c('span',{staticClass:"gl-dropdown-button-text",class:{ 'gl-sr-only': _vm.textSrOnly }},[_vm._v("\n        "+_vm._s(_vm.toggleText)+"\n      ")]),_vm._v(" "),(!_vm.noCaret)?_c('gl-icon',{staticClass:"gl-button-icon dropdown-chevron",attrs:{"name":"chevron-down"}}):_vm._e()]})],2),_vm._v(" "),_c('div',{ref:"content",staticClass:"dropdown-menu",class:{ show: _vm.visible },attrs:{"id":_vm.baseDropdownId,"data-testid":"base-dropdown-menu"},on:{"keydown":function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"esc",27,$event.key,["Esc","Escape"])){ return null; }$event.stopPropagation();$event.preventDefault();return _vm.closeAndFocus.apply(null, arguments)}}},[_c('div',{staticClass:"gl-dropdown-inner"},[_vm._t("default")],2)])],1)};
 var __vue_staticRenderFns__ = [];
 
   /* style */

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

@@ -0,0 +1,291 @@
+import _uniqueId from 'lodash/uniqueId';
+import _clamp from 'lodash/clamp';
+import { stopEvent } from '../../../../utils/utils';
+import { GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, HOME, END, ARROW_UP, ARROW_DOWN } from '../constants';
+import { buttonCategoryOptions, dropdownVariantOptions, buttonSizeOptions } from '../../../../utils/constants';
+import GlBaseDropdown from '../base_dropdown/base_dropdown';
+import GlDisclosureDropdownItem, { ITEM_CLASS } from './disclosure_dropdown_item';
+import GlDisclosureDropdownGroup from './disclosure_dropdown_group';
+import { itemsValidator, isAllItems, isAllGroups, isItem } from './utils';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  events: {
+    GL_DROPDOWN_SHOWN,
+    GL_DROPDOWN_HIDDEN
+  },
+  components: {
+    GlBaseDropdown,
+    GlDisclosureDropdownItem,
+    GlDisclosureDropdownGroup
+  },
+  props: {
+    /**
+     * Items to display in the dropdown
+     */
+    items: {
+      type: Array,
+      required: false,
+      default: () => [],
+      validator: itemsValidator
+    },
+    /**
+     * Toggle button text
+     */
+    toggleText: {
+      type: String,
+      required: false,
+      default: ''
+    },
+    /**
+     * Toggle text to be read by screen readers only
+     */
+    textSrOnly: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Styling option - dropdown's toggle category
+     */
+    category: {
+      type: String,
+      required: false,
+      default: buttonCategoryOptions.primary,
+      validator: value => value in buttonCategoryOptions
+    },
+    /**
+     * Styling option - dropdown's toggle variant
+     */
+    variant: {
+      type: String,
+      required: false,
+      default: dropdownVariantOptions.default,
+      validator: value => value in dropdownVariantOptions
+    },
+    /**
+     * The size of the dropdown toggle
+     */
+    size: {
+      type: String,
+      required: false,
+      default: 'medium',
+      validator: value => value in buttonSizeOptions
+    },
+    /**
+     * Icon name that will be rendered in the toggle button
+     */
+    icon: {
+      type: String,
+      required: false,
+      default: ''
+    },
+    /**
+     * Set to "true" to disable the dropdown
+     */
+    disabled: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Set to "true" when dropdown content (items) is loading
+     * It will render a small loader in the dropdown toggle and make it disabled
+     */
+    loading: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Additional CSS classes to customize toggle appearance
+     */
+    toggleClass: {
+      type: [String, Array, Object],
+      required: false,
+      default: null
+    },
+    /**
+     * Set to "true" to hide the caret
+     */
+    noCaret: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Right align disclosure dropdown with respect to the toggle button
+     */
+    right: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * The `aria-labelledby` attribute value for the toggle button
+     * Provide the string of ids seperated by space
+     */
+    toggleAriaLabelledBy: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * The `aria-labelledby` attribute value for the list of options
+     * Provide the string of ids seperated by space
+     */
+    listAriaLabelledBy: {
+      type: String,
+      required: false,
+      default: null
+    }
+  },
+  data() {
+    return {
+      toggleId: _uniqueId('dropdown-toggle-btn-'),
+      disclosureId: _uniqueId('disclosure-'),
+      nextFocusedItemIndex: null
+    };
+  },
+  computed: {
+    disclosureOptions() {
+      if (this.items) {
+        if (isAllItems(this.items)) {
+          return {
+            tag: 'ul'
+          };
+        }
+        if (isAllGroups(this.items)) return {
+          tag: 'div',
+          role: 'group'
+        };
+      }
+      return {
+        tag: 'div'
+      };
+    },
+    hasCustomToggle() {
+      return Boolean(this.$scopedSlots.toggle);
+    }
+  },
+  methods: {
+    open() {
+      this.$refs.baseDropdown.open();
+    },
+    close() {
+      this.$refs.baseDropdown.close();
+    },
+    onShow() {
+      const items = this.getFocusableListItemElements();
+      if (items.length) {
+        this.focusItem(0, items);
+      }
+
+      /**
+       * Emitted when dropdown is shown
+       *
+       * @event shown
+       */
+      this.$emit(GL_DROPDOWN_SHOWN);
+    },
+    onHide() {
+      /**
+       * Emitted when dropdown is hidden
+       *
+       * @event hidden
+       */
+      this.$emit(GL_DROPDOWN_HIDDEN);
+      this.nextFocusedItemIndex = null;
+    },
+    onKeydown(event) {
+      const {
+        code
+      } = event;
+      const elements = this.getFocusableListItemElements();
+      if (elements.length < 1) return;
+      let stop = true;
+      if (code === HOME) {
+        this.focusItem(0, elements);
+      } else if (code === END) {
+        this.focusItem(elements.length - 1, elements);
+      } else if (code === ARROW_UP) {
+        this.focusNextItem(event, elements, -1);
+      } else if (code === ARROW_DOWN) {
+        this.focusNextItem(event, elements, 1);
+      } else {
+        stop = false;
+      }
+      if (stop) {
+        stopEvent(event);
+      }
+    },
+    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 || []);
+    },
+    focusNextItem(event, elements, offset) {
+      const {
+        target
+      } = event;
+      const currentIndex = elements.indexOf(target);
+      const nextIndex = _clamp(currentIndex + offset, 0, elements.length - 1);
+      this.focusItem(nextIndex, elements);
+    },
+    focusItem(index, elements) {
+      var _elements$index;
+      this.nextFocusedItemIndex = index;
+      (_elements$index = elements[index]) === null || _elements$index === void 0 ? void 0 : _elements$index.focus();
+    },
+    closeAndFocus() {
+      this.$refs.baseDropdown.closeAndFocus();
+    },
+    handleAction(action) {
+      /**
+       * Emitted when one of disclosure dropdown items is clicked
+       *
+       * @event action
+       */
+      this.$emit('action', action);
+    },
+    isItem
+  }
+};
+
+/* 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,"right":_vm.right},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.disclosureOptions.tag,{ref:"content",tag:"component",staticClass:"gl-dropdown-contents gl-list-style-none gl-pl-0 gl-mb-0",attrs:{"id":_vm.disclosureId,"role":_vm.disclosureOptions.role,"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}},[_vm._t("list-item",null,{"item":item})],2)]:[_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,{key:"list-item",fn:function(){return [_vm._t("list-item")]},proxy:true}],null,true)})]]})]})],2),_vm._v(" "),_vm._t("footer")],2)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;

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

@@ -0,0 +1,90 @@
+import _uniqueId from 'lodash/uniqueId';
+import GlDisclosureDropdownItem from './disclosure_dropdown_item';
+import { isGroup } from './utils';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const GROUP_TOP_BORDER_CLASSES = 'gl-border-t gl-pt-3 gl-mt-3';
+var script = {
+  components: {
+    GlDisclosureDropdownItem
+  },
+  props: {
+    /**
+     * Group of items
+     */
+    group: {
+      type: Object,
+      required: false,
+      default: null,
+      validator: isGroup
+    },
+    /**
+     * If 'true', will set top border for the group
+     * to separate from other groups
+     */
+    bordered: {
+      type: Boolean,
+      required: false,
+      default: false
+    }
+  },
+  computed: {
+    borderClass() {
+      return this.bordered ? GROUP_TOP_BORDER_CLASSES : null;
+    },
+    showHeader() {
+      var _this$group;
+      return this.$scopedSlots['group-label'] || ((_this$group = this.group) === null || _this$group === void 0 ? void 0 : _this$group.name);
+    },
+    groupLabeledBy() {
+      return this.showHeader ? this.nameId : null;
+    }
+  },
+  created() {
+    this.nameId = _uniqueId('gl-disclosure-dropdown-group-');
+  },
+  methods: {
+    handleAction(action) {
+      this.$emit('action', action);
+    }
+  }
+};
+
+/* 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('div',{class:_vm.borderClass},[(_vm.showHeader)?_c('div',{staticClass:"gl-pl-5 gl-py-2 gl-font-sm gl-font-weight-bold",attrs:{"id":_vm.nameId,"aria-hidden":"true"}},[_vm._t("group-label",function(){return [_vm._v(_vm._s(_vm.group.name))]})],2):_vm._e(),_vm._v(" "),_c('ul',{staticClass:"gl-mb-0 gl-pl-0 gl-list-style-none",attrs:{"role":"group","aria-labelledby":_vm.groupLabeledBy}},[_vm._t("default",function(){return _vm._l((_vm.group.items),function(item){return _c('gl-disclosure-dropdown-item',{key:item.text,attrs:{"item":item},on:{"action":_vm.handleAction}},[_vm._t("list-item",null,{"item":item})],2)})})],2)])};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;
+export { GROUP_TOP_BORDER_CLASSES };

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

@@ -0,0 +1,107 @@
+import { ENTER, SPACE } from '../constants';
+import { stopEvent } from '../../../../utils/utils';
+import { isItem } from './utils';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const ITEM_CLASS = 'gl-dropdown-item';
+var script = {
+  ITEM_CLASS,
+  props: {
+    item: {
+      type: Object,
+      required: false,
+      default: null,
+      validator: isItem
+    }
+  },
+  computed: {
+    isActionItem() {
+      var _this$item;
+      return (_this$item = this.item) === null || _this$item === void 0 ? void 0 : _this$item.action;
+    },
+    isCustomContent() {
+      return Boolean(this.$scopedSlots.default);
+    },
+    itemComponent() {
+      if (this.isActionItem) return {
+        is: 'button',
+        attrs: {
+          ...this.item.extraAttrs
+        },
+        listeners: {
+          click: () => this.item.action()
+        }
+      };
+      return {
+        is: 'a',
+        attrs: {
+          href: this.item.href,
+          ...this.item.extraAttrs
+        },
+        listeners: {}
+      };
+    }
+  },
+  methods: {
+    onKeydown(event) {
+      const {
+        code
+      } = event;
+      if (code === ENTER || code === SPACE) {
+        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.
+         * `bubbles` is set to `true` as the parent `li` item has this event listener and thus we'll get a loop.
+         */
+        (_this$$refs$item = this.$refs.item) === null || _this$$refs$item === void 0 ? void 0 : _this$$refs$item.dispatchEvent(new MouseEvent('click', {
+          bubbles: false
+        }));
+        this.action();
+      }
+    },
+    action() {
+      this.$emit('action', this.item);
+    }
+  }
+};
+
+/* 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-dropdown-item gl-focusable-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:"dropdown-item"},[_c('div',{staticClass:"gl-dropdown-item-text-wrapper"},[_vm._t("default")],2)]):[_c(_vm.itemComponent.is,_vm._g(_vm._b({ref:"item",tag:"component",staticClass:"dropdown-item",attrs:{"tabindex":"-1"}},'component',_vm.itemComponent.attrs,false),_vm.itemComponent.listeners),[_c('span',{staticClass:"gl-dropdown-item-text-wrapper"},[_vm._v("\n        "+_vm._s(_vm.item.text)+"\n      ")])])]],2)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;
+export { ITEM_CLASS };