@gitlab/ui 132.0.0 → 132.0.2

package/dist/components/base/badge/badge.js

@@ -0,0 +1,197 @@
+import GlLink from '../link/link';
+import { badgeVariantOptions, badgeIconSizeOptions, linkVariantUnstyled } from '../../../utils/constants';
+import GlIcon from '../icon/icon';
+import { logWarning } from '../../../utils/utils';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+const variantClass = {
+  [badgeVariantOptions.neutral]: 'badge-neutral',
+  [badgeVariantOptions.info]: 'badge-info',
+  [badgeVariantOptions.success]: 'badge-success',
+  [badgeVariantOptions.warning]: 'badge-warning',
+  [badgeVariantOptions.danger]: 'badge-danger',
+  [badgeVariantOptions.tier]: 'badge-tier'
+};
+var script = {
+  name: 'GlBadge',
+  components: {
+    GlLink,
+    GlIcon
+  },
+  props: {
+    /**
+     * The variant of the badge.
+     */
+    variant: {
+      type: String,
+      default: badgeVariantOptions.neutral,
+      validator(value) {
+        return badgeVariantOptions[value] !== undefined;
+      },
+      required: false
+    },
+    /**
+     * The icon to show next to the text
+     */
+    icon: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * The size of the icon 16 or 12
+     */
+    iconSize: {
+      type: String,
+      default: 'md',
+      validator: value => Object.keys(badgeIconSizeOptions).includes(value),
+      required: false
+    },
+    /**
+     * Optically aligns circular icons with the badge.
+     */
+    iconOpticallyAligned: {
+      type: Boolean,
+      default: false,
+      required: false
+    },
+    /**
+     * Custom tag to use (unless `href` is defined)
+     */
+    tag: {
+      type: String,
+      required: false,
+      default: 'span'
+    },
+    /**
+     * Creates the badge as link (ignores `tag` property)
+     */
+    href: {
+      type: String,
+      required: false,
+      default: undefined
+    },
+    /**
+     * Sets the `rel` attributes, when `href` is defined
+     */
+    rel: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * Sets the `target`, when `href` is defined
+     */
+    target: {
+      type: String,
+      required: false,
+      default: '_self'
+    },
+    /**
+     * Adds the `active` class, when `href` is defined
+     */
+    active: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Disables the link, when `href` is defined
+     */
+    disabled: {
+      type: Boolean,
+      required: false,
+      default: false
+    }
+  },
+  computed: {
+    hasIconOnly() {
+      // eslint-disable-next-line @gitlab/vue-prefer-dollar-scopedslots
+      return Boolean(this.icon && Object.keys(this.$slots).length === 0);
+    },
+    isCircularIcon() {
+      return this.iconOpticallyAligned || ['issue-open-m', 'issue-close'].includes(this.icon);
+    },
+    role() {
+      return this.hasIconOnly ? 'img' : undefined;
+    },
+    iconSizeComputed() {
+      return badgeIconSizeOptions[this.iconSize];
+    },
+    isLink() {
+      return Boolean(this.href);
+    },
+    computedTag() {
+      return this.isLink ? GlLink : this.tag;
+    },
+    computedProps() {
+      if (!this.isLink) return {};
+      const {
+        href,
+        rel,
+        target,
+        active,
+        disabled
+      } = this;
+      return {
+        href,
+        rel,
+        target,
+        active,
+        disabled,
+        variant: linkVariantUnstyled
+      };
+    },
+    classes() {
+      return ['gl-badge', 'badge', 'badge-pill', variantClass[this.variant], {
+        '!gl-px-2': !this.$scopedSlots.default
+      }];
+    }
+  },
+  mounted() {
+    if (this.hasIconOnly && !this.$attrs['aria-label']) {
+      logWarning('Icon-only badges require an aria-label for accessibility. The label should describe the metadata (e.g., "Due date", "Open issue"), not the icon name. See https://design.gitlab.com/components/badge#using-icon-only-badges', {
+        name: 'GlBadge',
+        element: this.$el
+      });
+    }
+  }
+};
+
+/* 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(_vm.computedTag,_vm._g(_vm._b({tag:"component",class:_vm.classes,attrs:{"role":_vm.role}},'component',_vm.computedProps,false),_vm.$listeners),[(_vm.icon)?_c('gl-icon',{staticClass:"gl-badge-icon",class:{ '-gl-ml-2': _vm.isCircularIcon },attrs:{"size":_vm.iconSizeComputed,"name":_vm.icon}}):_vm._e(),_vm._v(" "),(_vm.$slots.default)?_c('span',{staticClass:"gl-badge-content"},[_vm._t("default")],2):_vm._e()],1)};
+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 { __vue_component__ as default };

package/dist/components/base/banner/banner.js

@@ -0,0 +1,149 @@
+import { bannerVariants } from '../../../utils/constants';
+import { translate } from '../../../utils/i18n';
+import CloseButton from '../../shared_components/close_button/close_button';
+import GlButton from '../button/button';
+import GlCard from '../card/card';
+import GlIllustration from '../illustration/illustration';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  name: 'GlBanner',
+  components: {
+    CloseButton,
+    GlButton,
+    GlCard,
+    GlIllustration
+  },
+  props: {
+    /**
+     * Used to set the title of the banner.
+     */
+    title: {
+      type: String,
+      required: true
+    },
+    /**
+     * HTML attributes to add to the submit button.
+     */
+    buttonAttributes: {
+      type: Object,
+      required: false,
+      default: () => ({})
+    },
+    /**
+     * Text for the submit button.
+     */
+    buttonText: {
+      type: String,
+      required: true
+    },
+    /**
+     * Link for the submit button.
+     */
+    buttonLink: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * The illustration's name.
+     */
+    illustrationName: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * The illustration's URL.
+     */
+    svgPath: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * The variant of the banner.
+     */
+    variant: {
+      type: String,
+      required: false,
+      default: bannerVariants[0],
+      validator(value) {
+        return bannerVariants.includes(value);
+      }
+    },
+    /**
+     * The close button's label, it is used for the button's aria-label attribute.
+     */
+    dismissLabel: {
+      type: String,
+      required: false,
+      default: () => translate('GlBanner.closeButtonTitle', 'Dismiss')
+    }
+  },
+  computed: {
+    isIntroducing() {
+      return this.variant === bannerVariants[1];
+    }
+  },
+  methods: {
+    handleClose() {
+      /**
+       * Emitted when the close button is clicked.
+       *
+       * @event close
+       * @type {object}
+       */
+      this.$emit('close');
+    },
+    primaryButtonClicked() {
+      /**
+       * Emitted when the primary action button is clicked.
+       *
+       * @event primary
+       * @type {object}
+       */
+      this.$emit('primary');
+    }
+  }
+};
+
+/* 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-card',{staticClass:"gl-banner gl-py-6 gl-pl-6 gl-pr-8",class:{
+    'gl-banner-introduction': _vm.isIntroducing,
+  },attrs:{"body-class":"gl-flex gl-bg-transparent !gl-p-0"}},[(_vm.svgPath || _vm.illustrationName)?_c('div',{staticClass:"gl-banner-illustration"},[(_vm.illustrationName)?_c('gl-illustration',{attrs:{"name":_vm.illustrationName}}):(_vm.svgPath)?_c('img',{attrs:{"src":_vm.svgPath,"alt":""}}):_vm._e()],1):_vm._e(),_vm._v(" "),_c('div',{staticClass:"gl-banner-content"},[_c('h2',{staticClass:"gl-banner-title"},[_vm._v(_vm._s(_vm.title))]),_vm._v(" "),_vm._t("default"),_vm._v(" "),_c('gl-button',_vm._b({attrs:{"variant":"confirm","category":"primary","data-testid":"gl-banner-primary-button","href":_vm.buttonLink},on:{"click":_vm.primaryButtonClicked}},'gl-button',_vm.buttonAttributes,false),[_vm._v(_vm._s(_vm.buttonText))]),_vm._v(" "),_vm._t("actions")],2),_vm._v(" "),_c('close-button',{staticClass:"gl-banner-close",attrs:{"label":_vm.dismissLabel},on:{"click":_vm.handleClose}})],1)};
+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 { __vue_component__ as default };

package/dist/components/base/breadcrumb/breadcrumb.js

@@ -0,0 +1,282 @@
+import { debounce } from 'lodash-es';
+import { translate } from '../../../utils/i18n';
+import GlAvatar from '../avatar/avatar';
+import GlDisclosureDropdown from '../new_dropdowns/disclosure/disclosure_dropdown';
+import { GlTooltipDirective } from '../../../directives/tooltip/tooltip';
+import { breadCrumbSizeOptions } from '../../../utils/constants';
+import ClipboardButton from '../../shared_components/clipboard_button/clipboard_button';
+import GlBreadcrumbItem from './breadcrumb_item';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+var script = {
+  name: 'GlBreadcrumb',
+  components: {
+    GlBreadcrumbItem,
+    GlAvatar,
+    GlDisclosureDropdown,
+    ClipboardButton
+  },
+  directives: {
+    GlTooltip: GlTooltipDirective
+  },
+  inheritAttrs: false,
+  props: {
+    /**
+     * The breadcrumb items to be displayed as links.
+     */
+    items: {
+      type: Array,
+      required: true,
+      default: () => [{
+        text: '',
+        href: ''
+      }],
+      validator: items => {
+        return items.every(item => {
+          const keys = Object.keys(item);
+          return keys.includes('text') && item.text && (keys.includes('href') || keys.includes('to'));
+        });
+      }
+    },
+    /**
+     * Accessible label for the breadcrumb navigation.
+     */
+    ariaLabel: {
+      type: String,
+      required: false,
+      default: 'Breadcrumb'
+    },
+    /**
+     * The label for the collapsed dropdown toggle. Screen-reader only.
+     */
+    showMoreLabel: {
+      type: String,
+      required: false,
+      default: () => translate('GlBreadcrumb.showMoreLabel', 'Show more breadcrumbs')
+    },
+    /**
+     * Allows to disable auto-resize behavior. Items will then overflow their container instead of being collapsed into a dropdown.
+     */
+    autoResize: {
+      type: Boolean,
+      required: false,
+      default: true
+    },
+    /**
+     * Size of the breadcrumb item. Use `sm` for page breadcrumbs.
+     */
+    size: {
+      type: String,
+      required: false,
+      default: breadCrumbSizeOptions.sm,
+      validator: value => Object.keys(breadCrumbSizeOptions).includes(value)
+    },
+    /**
+     * Copy to clipboard button for breadcrumbs path.
+     */
+    showClipboardButton: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    /**
+     * Custom path for copy to clipboard button. By default, it resolves to all items text values with `/` separator.
+     */
+    pathToCopy: {
+      type: String,
+      required: false,
+      default: null
+    },
+    /**
+     * Custom tooltip text for clipboard button.
+     */
+    clipboardTooltipText: {
+      type: String,
+      required: false,
+      default: null
+    }
+  },
+  data() {
+    return {
+      fittingItems: [...this.items],
+      // array of items that fit on the screen
+      overflowingItems: [],
+      // array of items that didn't fit and were put in a dropdown instead
+      totalBreadcrumbsWidth: 0,
+      // the total width of all breadcrumb items combined
+      widthPerItem: [],
+      // array with the individual widths of each breadcrumb item
+      dropdownWidth: 0,
+      // the width of the breadcrumb item containing the dropdown toggle
+      clipboardButtonWidth: 0,
+      // the width of the clipboard button at the end of breadcrumbs
+      resizeDone: false // to apply some CSS only during/after resizing
+    };
+  },
+  computed: {
+    hasCollapsible() {
+      return this.overflowingItems.length > 0;
+    },
+    breadcrumbStyle() {
+      return this.resizeDone ? {} : {
+        opacity: 0
+      };
+    },
+    itemClass() {
+      if (this.resizeDone && this.fittingItems.length === 1) {
+        return 'gl-breadcrumb-only-item';
+      }
+      return '';
+    },
+    dropdownSize() {
+      return this.size === 'sm' ? 'small' : 'medium';
+    },
+    avatarSize() {
+      return this.size === 'sm' ? 16 : 24;
+    },
+    clipboardButtonText() {
+      if (this.pathToCopy) return this.pathToCopy;
+      const items = Array.from(this.items, item => item.text);
+      return items.join('/');
+    }
+  },
+  watch: {
+    items: {
+      handler: 'measureAndMakeBreadcrumbsFit',
+      deep: true
+    },
+    autoResize(newValue) {
+      if (newValue) this.enableAutoResize();else this.disableAutoResize();
+    }
+  },
+  created() {
+    this.debounceMakeBreadcrumbsFit = debounce(this.makeBreadcrumbsFit, 25);
+  },
+  mounted() {
+    if (this.autoResize) {
+      this.enableAutoResize();
+    } else {
+      this.resizeDone = true;
+    }
+    this.updateClipboardButtonWidth();
+  },
+  beforeDestroy() {
+    this.disableAutoResize();
+  },
+  methods: {
+    updateClipboardButtonWidth() {
+      if (!this.showClipboardButton) {
+        this.clipboardButtonWidth = 0;
+        return;
+      }
+      const element = this.$refs.clipboardButton.$el;
+      const marginLeft = parseInt(getComputedStyle(element).marginLeft, 10);
+      this.clipboardButtonWidth = element.offsetWidth + marginLeft;
+    },
+    resetItems() {
+      this.fittingItems = [...this.items];
+      this.overflowingItems = [];
+    },
+    async measureAndMakeBreadcrumbsFit() {
+      this.resetItems();
+      if (!this.autoResize) return;
+      this.resizeDone = false;
+
+      // Wait for DOM update so all items get rendered and can be measured.
+      await this.$nextTick();
+      this.totalBreadcrumbsWidth = 0;
+      if (!this.$refs.breadcrumbs) return;
+      this.$refs.breadcrumbs.forEach((b, index) => {
+        const width = b.$el.clientWidth;
+        this.totalBreadcrumbsWidth += width;
+        this.widthPerItem[index] = width;
+      });
+      this.totalBreadcrumbsWidth += this.clipboardButtonWidth;
+
+      // The dropdown gets rendered during `!resizeDone` so we can measure its real width here.
+      this.dropdownWidth = this.$refs.dropdown.clientWidth;
+      this.makeBreadcrumbsFit();
+    },
+    makeBreadcrumbsFit() {
+      this.resizeDone = false;
+      this.resetItems();
+      const containerWidth = this.$el.clientWidth;
+      if (this.totalBreadcrumbsWidth > containerWidth) {
+        // Not all breadcrumb items fit. Start moving items over to the dropdown.
+        const startSlicingAt = 0;
+
+        // The last item will never be moved into the dropdown.
+        const stopSlicingAt = this.items.length - 1;
+        let widthNeeded = this.totalBreadcrumbsWidth;
+        for (let index = startSlicingAt; index < stopSlicingAt; index += 1) {
+          // Move one breadcrumb item into the dropdown
+          this.overflowingItems.push(this.fittingItems[startSlicingAt]);
+          this.fittingItems.splice(startSlicingAt, 1);
+          widthNeeded -= this.widthPerItem[index];
+
+          // Does it fit now? Then stop.
+          if (widthNeeded + this.dropdownWidth < containerWidth) break;
+        }
+      }
+      const truncatedItemMaxWidth = Math.max(0, containerWidth - (this.dropdownWidth + this.clipboardButtonWidth));
+      this.$el.style.setProperty('--gl-breadcrumb-truncated-item-max-width', `${truncatedItemMaxWidth}px`);
+      this.resizeDone = true;
+    },
+    isLastItem(index) {
+      return index === this.fittingItems.length - 1;
+    },
+    getAriaCurrentAttr(index) {
+      return this.isLastItem(index) ? 'page' : false;
+    },
+    enableAutoResize() {
+      this.resizeObserver || (this.resizeObserver = new ResizeObserver(this.debounceMakeBreadcrumbsFit));
+      this.resizeObserver.observe(this.$el);
+      this.measureAndMakeBreadcrumbsFit();
+    },
+    disableAutoResize() {
+      if (this.resizeObserver) {
+        this.resizeObserver.unobserve(this.$el);
+        this.resizeObserver = null;
+      }
+      this.resetItems();
+    }
+  }
+};
+
+/* 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('nav',{staticClass:"gl-breadcrumbs",style:(_vm.breadcrumbStyle),attrs:{"aria-label":_vm.ariaLabel}},[_c('ol',_vm._g(_vm._b({staticClass:"gl-breadcrumb-list breadcrumb"},'ol',_vm.$attrs,false),_vm.$listeners),[(_vm.hasCollapsible || !_vm.resizeDone)?_c('li',{ref:"dropdown",class:("gl-breadcrumb-item gl-breadcrumb-item-" + _vm.size)},[_c('gl-disclosure-dropdown',{attrs:{"items":_vm.overflowingItems,"toggle-text":_vm.showMoreLabel,"fluid-width":"","text-sr-only":"","no-caret":"","icon":"ellipsis_h","size":_vm.dropdownSize}})],1):_vm._e(),_vm._v(" "),_vm._l((_vm.fittingItems),function(item,index){return _c('gl-breadcrumb-item',{key:index,ref:"breadcrumbs",refInFor:true,class:_vm.itemClass,attrs:{"text":item.text,"href":item.href,"to":item.to,"size":_vm.size,"aria-current":_vm.getAriaCurrentAttr(index)},scopedSlots:_vm._u([{key:"default",fn:function(){return [(item.avatarPath)?_c('gl-avatar',{staticClass:"gl-breadcrumb-avatar-tile gl-border gl-mr-2",attrs:{"src":item.avatarPath,"size":_vm.avatarSize,"aria-hidden":"true","shape":"rect","data-testid":"avatar"}}):_vm._e(),_c('span',{staticClass:"gl-align-middle"},[_vm._v(_vm._s(item.text))])]},proxy:true}],null,true)})}),_vm._v(" "),(_vm.showClipboardButton)?_c('li',{staticClass:"gl-breadcrumb-clipboard-button"},[_c('clipboard-button',_vm._b({ref:"clipboardButton",staticClass:"gl-ml-2",attrs:{"data-testid":"copy-to-clipboard-button","text":_vm.clipboardButtonText,"size":_vm.dropdownSize}},'clipboard-button',_vm.clipboardTooltipText ? { title: _vm.clipboardTooltipText } : {},false))],1):_vm._e()],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 { __vue_component__ as default };