@gitlab/ui 32.59.0 → 32.60.0

package/package.json

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

package/src/components/base/breadcrumb/breadcrumb.spec.js

@@ -1,6 +1,7 @@
 import { shallowMount } from '@vue/test-utils';
 import { BBreadcrumbItem } from 'bootstrap-vue';
-import Breadcrumb from './breadcrumb.vue';
+import Breadcrumb, { COLLAPSE_AT_SIZE } from './breadcrumb.vue';
+import { createMockDirective } from '~helpers/vue_mock_directive';
 
 describe('Broadcast message component', () => {
   let wrapper;
@@ -14,10 +15,24 @@ describe('Broadcast message component', () => {
     { text: 'third_breadcrumb', href: 'http://about.gitlab.com' },
   ];
 
+  const extraItems = [
+    { text: 'fourth_breadcrumb', href: 'http://gitlab.com' },
+    {
+      text: 'fifth_breadcrumb',
+      to: 'to_value',
+    },
+  ];
+
   const findAvatarSlot = () => wrapper.find('[data-testid="avatar-slot"]');
   const findSeparatorSlot = () => wrapper.find('[data-testid="separator-slot"]');
   const findBreadcrumbItems = () => wrapper.findAllComponents(BBreadcrumbItem);
   const findAllSeparators = () => wrapper.findAll('[data-testid="separator"]');
+  const findCollapsedListExpander = () => wrapper.find('[data-testid="collapsed-expander"]');
+  const findExpanderSeparator = () => wrapper.find('[data-testid="expander-separator"]');
+
+  const findVisibleBreadcrumbItems = () =>
+    wrapper.findAll('.gl-breadcrumb-item:not(.gl-display-none)');
+  const findHiddenBreadcrumbItems = () => wrapper.findAll('.gl-breadcrumb-item.gl-display-none');
 
   const createComponent = (propsData = { items }) => {
     wrapper = shallowMount(Breadcrumb, {
@@ -26,7 +41,14 @@ describe('Broadcast message component', () => {
         avatar: '<div data-testid="avatar-slot"></div>',
         separator: '<div data-testid="separator-slot"></div>',
       },
+      directives: { GlTooltip: createMockDirective('gl-tooltip') },
     });
+
+    wrapper.vm.$refs.firstItem = [
+      {
+        querySelector: () => ({ focus: jest.fn() }),
+      },
+    ];
   };
 
   describe('slots', () => {
@@ -82,4 +104,45 @@ describe('Broadcast message component', () => {
       });
     });
   });
+
+  describe('collapsible', () => {
+    describe(`when breadcrumbs list size is NOT larger than ${COLLAPSE_AT_SIZE}`, () => {
+      beforeEach(() => {
+        createComponent();
+      });
+      it('should not display collapsed list expander && separator', () => {
+        expect(findCollapsedListExpander().exists()).toBe(false);
+        expect(findExpanderSeparator().exists()).toBe(false);
+      });
+
+      it('should display all items visible', () => {
+        expect(findVisibleBreadcrumbItems()).toHaveLength(items.length);
+      });
+    });
+
+    describe(`when breadcrumbs list size is larger than ${COLLAPSE_AT_SIZE}`, () => {
+      beforeEach(() => {
+        createComponent({ items: [...items, ...extraItems] });
+      });
+      it('should display collapsed list expander && separator', () => {
+        expect(findCollapsedListExpander().exists()).toBe(true);
+        expect(findExpanderSeparator().exists()).toBe(true);
+      });
+
+      it('should display only first && 2 last items and the rest as hidden', () => {
+        const alwaysVisibleNum = 3;
+        expect(findVisibleBreadcrumbItems()).toHaveLength(alwaysVisibleNum);
+        expect(findHiddenBreadcrumbItems()).toHaveLength(
+          items.length + extraItems.length - alwaysVisibleNum
+        );
+      });
+
+      it('should expand the list on expander click', async () => {
+        findCollapsedListExpander().vm.$emit('click');
+        await wrapper.vm.$nextTick();
+        expect(findHiddenBreadcrumbItems()).toHaveLength(0);
+        expect(findVisibleBreadcrumbItems()).toHaveLength(items.length + extraItems.length);
+      });
+    });
+  });
 });

package/src/components/base/breadcrumb/breadcrumb.stories.js

@@ -60,3 +60,25 @@ export default {
     },
   },
 };
+
+const extraItems = [
+  {
+    text: 'Fifth Item',
+    href: '#',
+  },
+  {
+    text: 'Sixth Item',
+    href: '#',
+  },
+  {
+    text: 'Seventh Item',
+    href: '#',
+  },
+  {
+    text: 'Eighth Item',
+    href: '#',
+  },
+];
+
+export const CollapsedItems = Template.bind({});
+CollapsedItems.args = generateProps({ items: [...defaultItems, ...extraItems] });

package/src/components/base/breadcrumb/breadcrumb.vue

@@ -1,12 +1,20 @@
 <script>
 import { BBreadcrumb, BBreadcrumbItem } from 'bootstrap-vue';
 import GlIcon from '../icon/icon.vue';
+import GlButton from '../button/button.vue';
+import { GlTooltipDirective } from '../../../directives/tooltip';
+
+export const COLLAPSE_AT_SIZE = 4;
 
 export default {
   components: {
     BBreadcrumb,
     BBreadcrumbItem,
     GlIcon,
+    GlButton,
+  },
+  directives: {
+    GlTooltip: GlTooltipDirective,
   },
   inheritAttrs: false,
   props: {
@@ -25,9 +33,45 @@ export default {
       },
     },
   },
+  data() {
+    return {
+      isListCollapsed: true,
+    };
+  },
+  computed: {
+    breadcrumbsSize() {
+      return this.items.length;
+    },
+    hasCollapsible() {
+      return this.breadcrumbsSize > COLLAPSE_AT_SIZE;
+    },
+    nonCollapsibleIndices() {
+      return [0, this.breadcrumbsSize - 1, this.breadcrumbsSize - 2];
+    },
+  },
   methods: {
-    isLastItem(items, index) {
-      return index === items.length - 1;
+    isFirstItem(index) {
+      return index === 0;
+    },
+    isLastItem(index) {
+      return index === this.breadcrumbsSize - 1;
+    },
+    expandBreadcrumbs() {
+      this.isListCollapsed = false;
+      try {
+        this.$refs.firstItem[0].querySelector('a').focus();
+      } catch (e) {
+        /* eslint-disable-next-line no-console */
+        console.error(`Failed to set focus on the last breadcrumb item.`);
+      }
+    },
+    showCollapsedBreadcrumbsExpander(index) {
+      return index === 0 && this.hasCollapsible && this.isListCollapsed;
+    },
+    isItemCollapsed(index) {
+      return (
+        this.hasCollapsible && this.isListCollapsed && !this.nonCollapsibleIndices.includes(index)
+      );
     },
   },
 };
@@ -40,14 +84,16 @@ export default {
       <template v-for="(item, index) in items">
         <b-breadcrumb-item
           :key="index"
+          :ref="isFirstItem(index) ? 'firstItem' : null"
           class="gl-breadcrumb-item"
           :text="item.text"
           :href="item.href"
           :to="item.to"
+          :class="{ 'gl-display-none': isItemCollapsed(index) }"
         >
           <span>{{ item.text }}</span>
           <span
-            v-if="!isLastItem(items, index)"
+            v-if="!isLastItem(index)"
             :key="`${index} ${item.text}`"
             class="gl-breadcrumb-separator"
             data-testid="separator"
@@ -58,6 +104,28 @@ export default {
             </slot>
           </span>
         </b-breadcrumb-item>
+
+        <template v-if="showCollapsedBreadcrumbsExpander(index)">
+          <!-- eslint-disable-next-line vue/valid-v-for -->
+          <gl-button
+            v-gl-tooltip.hover="'Show all breadcrumbs'"
+            aria-label="Show all breadcrumbs"
+            data-testid="collapsed-expander"
+            icon="ellipsis_h"
+            category="primary"
+            @click="expandBreadcrumbs"
+          />
+          <!-- eslint-disable-next-line vue/require-v-for-key -->
+          <span
+            key="expander"
+            class="gl-display-inline-flex gl-text-gray-500"
+            data-testid="expander-separator"
+          >
+            <slot name="separator">
+              <gl-icon name="chevron-right" />
+            </slot>
+          </span>
+        </template>
       </template>
     </b-breadcrumb>
   </nav>

package/src/scss/utilities.scss

@@ -5586,6 +5586,16 @@
   margin-bottom: $gl-spacing-scale-3 !important;
   }
 }
+.gl-xs-mb-4 {
+  @include gl-media-breakpoint-down(sm) {
+  margin-bottom: $gl-spacing-scale-4;
+  }
+}
+.gl-xs-mb-4\! {
+  @include gl-media-breakpoint-down(sm) {
+  margin-bottom: $gl-spacing-scale-4 !important;
+  }
+}
 .gl-sm-ml-3 {
   @include gl-media-breakpoint-up(sm) {
   margin-left: $gl-spacing-scale-3;

package/src/scss/utility-mixins/spacing.scss

@@ -761,6 +761,12 @@
   }
 }
 
+@mixin gl-xs-mb-4 {
+  @include gl-media-breakpoint-down(sm) {
+    @include gl-mb-4;
+  }
+}
+
 @mixin gl-sm-ml-3 {
   @include gl-media-breakpoint-up(sm) {
     @include gl-ml-3;