@gitlab/ui 132.0.0 → 132.0.2

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

@@ -0,0 +1,5 @@
+const FIXED_WIDTH_CLASS = '!gl-w-31';
+const DEFAULT_OFFSET = 8;
+const ARROW_X_MINIMUM = 24;
+
+export { ARROW_X_MINIMUM, DEFAULT_OFFSET, FIXED_WIDTH_CLASS };

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

@@ -0,0 +1,32 @@
+import { MountingPortal } from 'portal-vue';
+import { POSITION_ABSOLUTE, POSITION_FIXED } from '../constants';
+
+/* eslint-disable import/no-default-export */
+var dropdown_container = {
+  props: {
+    /**
+     * Strategy to be applied by computePosition. If this is set to fixed, the dropdown's position
+     * needs to be set to fixed in CSS as well.
+     * https://floating-ui.com/docs/computePosition#strategy
+     */
+    positioningStrategy: {
+      type: String,
+      required: false,
+      default: POSITION_ABSOLUTE,
+      validator: strategy => [POSITION_ABSOLUTE, POSITION_FIXED].includes(strategy)
+    }
+  },
+  render(createElement) {
+    if (this.positioningStrategy === POSITION_FIXED) {
+      return createElement(MountingPortal, {
+        props: {
+          mountTo: 'body',
+          append: true
+        }
+      }, [this.$scopedSlots.default()]);
+    }
+    return this.$scopedSlots.default();
+  }
+};
+
+export { dropdown_container as default };

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

@@ -0,0 +1,24 @@
+// base dropdown events
+const GL_DROPDOWN_SHOWN = 'shown';
+const GL_DROPDOWN_HIDDEN = 'hidden';
+const GL_DROPDOWN_BEFORE_CLOSE = 'beforeClose';
+const GL_DROPDOWN_FOCUS_CONTENT = 'focusContent';
+
+// KeyboardEvent.code values
+const ARROW_DOWN = 'ArrowDown';
+const ARROW_UP = 'ArrowUp';
+const END = 'End';
+const ENTER = 'Enter';
+const HOME = 'Home';
+const SPACE = 'Space';
+
+// KeyboardEvent.keyCode values
+const KEY_CODE_ESCAPE = 27;
+
+// Positioning strategies
+// https://floating-ui.com/docs/computePosition#strategy
+const POSITION_ABSOLUTE = 'absolute';
+const POSITION_FIXED = 'fixed';
+const GL_DROPDOWN_CONTENTS_CLASS = 'gl-new-dropdown-contents';
+
+export { ARROW_DOWN, ARROW_UP, END, ENTER, GL_DROPDOWN_BEFORE_CLOSE, GL_DROPDOWN_CONTENTS_CLASS, GL_DROPDOWN_FOCUS_CONTENT, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_SHOWN, HOME, KEY_CODE_ESCAPE, POSITION_ABSOLUTE, POSITION_FIXED, SPACE };

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

@@ -0,0 +1,8 @@
+const DISCLOSURE_DROPDOWN_ITEM_NAME = 'GlDisclosureDropdownItem';
+const DISCLOSURE_DROPDOWN_GROUP_NAME = 'GlDisclosureDropdownGroup';
+const DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS = {
+  top: 'top',
+  bottom: 'bottom'
+};
+
+export { DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS, DISCLOSURE_DROPDOWN_GROUP_NAME, DISCLOSURE_DROPDOWN_ITEM_NAME };

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

@@ -0,0 +1,400 @@
+import { uniqueId, clamp } from 'lodash-es';
+import { logWarning, stopEvent, filterVisible } from '../../../../utils/utils';
+import { GL_DROPDOWN_SHOWN, GL_DROPDOWN_HIDDEN, GL_DROPDOWN_BEFORE_CLOSE, GL_DROPDOWN_FOCUS_CONTENT, POSITION_ABSOLUTE, POSITION_FIXED, HOME, END, ARROW_UP, ARROW_DOWN, ENTER, SPACE, GL_DROPDOWN_CONTENTS_CLASS } 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';
+import GlDisclosureDropdownGroup from './disclosure_dropdown_group';
+import { itemsValidator, hasOnlyListItems, doSomeItemsHaveIcon, isItem } from './utils';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const ITEM_SELECTOR = `.${ITEM_CLASS}`;
+var script = {
+  name: 'GlDisclosureDropdown',
+  events: {
+    GL_DROPDOWN_SHOWN,
+    GL_DROPDOWN_HIDDEN,
+    GL_DROPDOWN_BEFORE_CLOSE,
+    GL_DROPDOWN_FOCUS_CONTENT
+  },
+  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
+    },
+    /**
+     * Custom toggle id.
+     * For instance, it can be referenced by tooltip or popover
+     */
+    toggleId: {
+      type: String,
+      required: false,
+      default: () => uniqueId('dropdown-toggle-btn-')
+    },
+    /**
+     * 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
+    },
+    /**
+     * Align disclosure dropdown with respect to the toggle button
+     */
+    placement: {
+      type: String,
+      required: false,
+      default: 'bottom-start',
+      validator: value => Object.keys(dropdownPlacements).includes(value)
+    },
+    /**
+     * 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-label` attribute value for the toggle button.
+     * Use when there is no visible label element to reference with `toggleAriaLabelledBy`.
+     * Do not provide both `toggleAriaLabel` and `toggleAriaLabelledBy`.
+     * When both are present, `toggleAriaLabelledBy` takes precedence per the WAI-ARIA spec.
+     */
+    toggleAriaLabel: {
+      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
+    },
+    /**
+     * Render the toggle button as a block element
+     */
+    block: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Custom offset to be applied to Floating UI's offset middleware.
+     * https://floating-ui.com/docs/offset
+     */
+    dropdownOffset: {
+      type: [Number, Object],
+      required: false,
+      default: undefined
+    },
+    /**
+     * Lets the dropdown extend to match its content's width, up to a maximum width
+     * defined by the `$gl-new-dropdown-max-width` variable.
+     */
+    fluidWidth: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Close the dropdown on item click (action)
+     */
+    autoClose: {
+      type: Boolean,
+      required: false,
+      default: true
+    },
+    /**
+     * Strategy to be applied by computePosition. If the dropdown's container is too short for it to
+     * fit in, setting this to fixed will let it position itself above its container.
+     * https://floating-ui.com/docs/computePosition#strategy
+     */
+    positioningStrategy: {
+      type: String,
+      required: false,
+      default: POSITION_ABSOLUTE,
+      validator: strategy => [POSITION_ABSOLUTE, POSITION_FIXED].includes(strategy)
+    },
+    /**
+     * Opens dropdown on render
+     */
+    startOpened: {
+      type: Boolean,
+      required: false,
+      default: false
+    }
+  },
+  data() {
+    return {
+      disclosureId: uniqueId('disclosure-'),
+      nextFocusedItemIndex: null
+    };
+  },
+  computed: {
+    disclosureTag() {
+      var _this$items;
+      if ((_this$items = this.items) !== null && _this$items !== void 0 && _this$items.length ||
+      // eslint-disable-next-line @gitlab/vue-prefer-dollar-scopedslots
+      hasOnlyListItems(this.$scopedSlots.default || this.$slots.default)) {
+        return 'ul';
+      }
+      return 'div';
+    },
+    hasCustomToggle() {
+      return Boolean(this.$scopedSlots.toggle);
+    },
+    siblingsHaveIcons() {
+      return doSomeItemsHaveIcon(this.items);
+    }
+  },
+  mounted() {
+    if (this.toggleAriaLabel && this.toggleAriaLabelledBy) {
+      logWarning('Do not provide both `toggleAriaLabel` and `toggleAriaLabelledBy`. ' + 'When both are present, `toggleAriaLabelledBy` takes precedence and `toggleAriaLabel` is ignored. ' + 'See https://design.gitlab.com/components/dropdown-disclosure/#accessibility', {
+        name: 'GlDisclosureDropdown'
+      });
+    }
+    if (this.startOpened) {
+      this.open();
+    }
+  },
+  methods: {
+    doSomeItemsHaveIcon,
+    open() {
+      this.$refs.baseDropdown.open();
+    },
+    close() {
+      this.$refs.baseDropdown.close();
+    },
+    onShow() {
+      /**
+       * Emitted when dropdown is shown
+       *
+       * @event shown
+       */
+      this.$emit(GL_DROPDOWN_SHOWN);
+    },
+    onBeforeClose(event) {
+      /**
+       * Emitted when dropdown is about to be closed
+       *
+       * @event beforeClose
+       */
+      this.$emit(GL_DROPDOWN_BEFORE_CLOSE, event);
+    },
+    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 if (code === ENTER || code === SPACE) {
+        this.handleAutoClose(event);
+      } 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_SELECTOR);
+      return filterVisible(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) {
+      // See https://gitlab.com/gitlab-org/gitlab-ui/-/merge_requests/4376 for
+      // detailed explanation why we need requestAnimationFrame
+      window.requestAnimationFrame(() => {
+        /**
+         * Emitted when one of disclosure dropdown items is clicked
+         *
+         * @event action
+         */
+        this.$emit('action', action);
+      });
+    },
+    handleAutoClose(e) {
+      var _this$$refs$baseDropd, _this$$refs$baseDropd2;
+      if (this.autoClose && e.target.closest(ITEM_SELECTOR) && // The optional chaining here is to accommodate specs that use shallow mounting.
+      // Ideally, those specs would either:
+      //  - stub out the `BaseDropdown` component to include a stub `containsElement` method, or
+      //  - use a full mount.
+      //
+      // Unfortunately, GitLab has many specs which do neither of these. So the simpler thing to do
+      // is to optionally chain the method call here.
+      (_this$$refs$baseDropd = (_this$$refs$baseDropd2 = this.$refs.baseDropdown).containsElement) !== null && _this$$refs$baseDropd !== void 0 && _this$$refs$baseDropd.call(_this$$refs$baseDropd2, e.target)) {
+        this.closeAndFocus();
+      }
+    },
+    uniqueItemId() {
+      return uniqueId(`disclosure-item-`);
+    },
+    isItem
+  },
+  GL_DROPDOWN_CONTENTS_CLASS
+};
+
+/* 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,"aria-label":_vm.toggleAriaLabelledBy ? undefined : _vm.toggleAriaLabel,"arrow-element":_vm.$refs.disclosureArrow,"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,"block":_vm.block,"offset":_vm.dropdownOffset,"fluid-width":_vm.fluidWidth,"positioning-strategy":_vm.positioningStrategy,"is-disclosure":""},on:_vm._d({},[_vm.$options.events.GL_DROPDOWN_SHOWN,_vm.onShow,_vm.$options.events.GL_DROPDOWN_HIDDEN,_vm.onHide,_vm.$options.events.GL_DROPDOWN_BEFORE_CLOSE,_vm.onBeforeClose,_vm.$options.events.GL_DROPDOWN_FOCUS_CONTENT,_vm.onKeydown]),scopedSlots:_vm._u([(_vm.hasCustomToggle)?{key:"toggle",fn:function(slotProps){return [_vm._t("toggle",null,null,slotProps)]}}:null],null,true)},[_vm._v(" "),_vm._t("header"),_vm._v(" "),_c(_vm.disclosureTag,{ref:"content",tag:"component",class:_vm.$options.GL_DROPDOWN_CONTENTS_CLASS,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:{"siblings-have-icons":_vm.siblingsHaveIcons,"item":item},on:{"action":_vm.handleAction},scopedSlots:_vm._u([('list-item' in _vm.$scopedSlots)?{key:"list-item",fn:function(){return [_vm._t("list-item",null,{"item":item})]},proxy:true}:null],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,(_vm.$scopedSlots['list-item'])?{key:"default",fn:function(){return _vm._l((item.items),function(groupItem){return _c('gl-disclosure-dropdown-item',{key:_vm.uniqueItemId(),attrs:{"siblings-have-icons":_vm.doSomeItemsHaveIcon(item.items),"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)})})},proxy:true}:null],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__ = /*#__PURE__*/__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 { ITEM_SELECTOR, __vue_component__ as default };

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

@@ -0,0 +1,112 @@
+import { uniqueId } from 'lodash-es';
+import GlDisclosureDropdownItem from './disclosure_dropdown_item';
+import { isGroup, doSomeItemsHaveIcon } from './utils';
+import { DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS, DISCLOSURE_DROPDOWN_GROUP_NAME } from './constants';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const BORDER_CLASSES = {
+  [DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS.top]: 'gl-border-t gl-border-t-dropdown-divider gl-pt-2 gl-mt-2',
+  [DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS.bottom]: 'gl-border-b gl-border-b-dropdown-divider gl-pb-2 gl-mb-2'
+};
+var script = {
+  name: DISCLOSURE_DROPDOWN_GROUP_NAME,
+  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. You can control
+     * the border position using the `borderPosition`
+     * property.
+     */
+    bordered: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Controls the position of the group's border. Valid
+     * values are 'top' and 'bottom'.
+     */
+    borderPosition: {
+      type: String,
+      required: false,
+      default: DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS.top,
+      validator: value => Object.keys(DISCLOSURE_DROPDOWN_GROUP_BORDER_POSITIONS).includes(value)
+    }
+  },
+  computed: {
+    borderClass() {
+      return this.bordered ? BORDER_CLASSES[this.borderPosition] : 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;
+    },
+    siblingsHaveIcons() {
+      return doSomeItemsHaveIcon(this.group.items);
+    }
+  },
+  created() {
+    this.nameId = uniqueId('gl-disclosure-dropdown-group-');
+  },
+  methods: {
+    handleAction(action) {
+      this.$emit('action', action);
+    },
+    uniqueItemId() {
+      return uniqueId(`disclosure-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',{class:_vm.borderClass},[(_vm.showHeader)?_c('div',{staticClass:"gl-py-2 gl-pl-4 gl-text-sm gl-font-bold gl-text-strong",attrs:{"id":_vm.nameId}},[_vm._t("group-label",function(){return [_vm._v(_vm._s(_vm.group.name))]})],2):_vm._e(),_vm._v(" "),_c('ul',{staticClass:"gl-new-dropdown-item-group gl-mb-0 gl-list-none gl-pl-0",attrs:{"aria-labelledby":_vm.groupLabeledBy}},[_vm._t("default",function(){return _vm._l((_vm.group.items),function(item){return _c('gl-disclosure-dropdown-item',{key:_vm.uniqueItemId(),attrs:{"siblings-have-icons":_vm.siblingsHaveIcons,"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)})})})],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__ = /*#__PURE__*/__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 { BORDER_CLASSES, __vue_component__ as default };