@gitlab/ui 32.56.0 → 32.60.0

package/documentation/documented_stories.js

@@ -116,6 +116,7 @@ export const setupStorybookReadme = () =>
         'GlModal',
         'GlKeysetPagination',
         'GlForm',
+        'GlTable',
       ],
       components: {
         GlComponentDocumentation,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "32.56.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/components/base/table/table.documentation.js

@@ -1,9 +1,6 @@
-import examples from './examples';
 import description from './table.md';
 
 export default {
   followsDesignSystem: false,
   description,
-  examples,
-  bootstrapComponent: 'b-table',
 };

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

@@ -1,13 +1,6 @@
-import { withKnobs, boolean, select, text } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
 import { GlTable } from '../../../../index';
-import { variantOptions } from '../../../utils/constants';
 import readme from './table.md';
 
-const components = {
-  GlTable,
-};
-
 const tableItems = [
   {
     column_one: 'test',
@@ -23,75 +16,96 @@ const tableItems = [
   },
 ];
 
-function generateProps() {
-  const props = {
-    fixed: {
-      type: Boolean,
-      default: boolean('fixed', false),
-    },
-    footClone: {
-      type: Boolean,
-      default: boolean('foot-clone', false),
+const generateProps = ({ fixed = false, footClone = false, stacked = false } = {}) => ({
+  fixed,
+  footClone,
+  stacked,
+});
+
+export const Default = (args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  template: `
+  <gl-table
+    :items="$options.items"
+    :fields="$options.fields"
+    :fixed="fixed"
+    :stacked="stacked"
+    :foot-clone="footClone"
+    hover
+    selectable
+    selected-variant="primary"
+  />
+`,
+  fields: [
+    {
+      key: 'column_one',
+      label: 'Column One',
+      variant: 'secondary',
+      sortable: false,
+      isRowHeader: false,
     },
-    stacked: {
-      type: [String, Boolean],
-      default: select('stacked', ['sm', 'md', 'lg', 'xl', true, false], false),
+    {
+      key: 'col_2',
+      label: 'Column 2',
+      formatter: (value) => value,
     },
-  };
+  ],
+  items: tableItems,
+});
+Default.args = generateProps();
 
-  return props;
-}
-
-documentedStoriesOf('base/table/table', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    props: generateProps(),
-    template: `
-      <gl-table
-        :items="$options.items"
-        :fields="$options.fields"
-        :fixed="fixed"
-        :stacked="stacked"
-        :foot-clone="footClone"
-        hover
-        selectable
-        selected-variant="primary"
-      />
-    `,
-    fields: [
-      {
-        key: 'column_one',
-        label: 'Column One',
-        variant: select('variant', variantOptions, variantOptions.secondary),
-        sortable: boolean('sortable', false),
-        isRowHeader: boolean('isRowHeader', false),
-      },
-      {
-        key: 'col_2',
-        label: 'Column 2',
-        formatter: (value) => `${text('formatterExample', '$')}${value}`,
-      },
-    ],
-    items: tableItems,
-  }))
-  .add('empty', () => ({
-    components,
-    template: `
+export const Empty = (args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  template: `
       <gl-table show-empty />
     `,
-  }))
-  .add('with filter', () => ({
-    components,
-    template: `<div class="gl-line-height-normal">
+});
+Empty.parameters = { controls: { disable: true } };
+
+export const WithFilter = (args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  template: `<div class="gl-line-height-normal">
       <gl-form-input v-model="filter" placeholder="Type to search" />
       <br />
-      <gl-table :items="$options.items" :fields="$options.fields" :filter=filter />
-     </div>`,
-    items: tableItems,
-    data() {
-      return {
-        filter: null,
-      };
+      <gl-table 
+              :items="$options.items" 
+              :fields="$options.fields" 
+              :filter=filter
+              :fixed="fixed"
+              :stacked="stacked"
+              :foot-clone="footClone"
+              hover
+              selectable
+              selected-variant="primary"
+          />
+      </div>`,
+  items: tableItems,
+  data() {
+    return {
+      filter: null,
+    };
+  },
+});
+WithFilter.args = generateProps();
+
+export default {
+  title: 'base/table/table',
+  component: GlTable,
+  parameters: {
+    bootstrapComponent: 'b-table',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
     },
-  }));
+  },
+  argTypes: {
+    stacked: {
+      control: {
+        type: 'select',
+        options: ['sm', 'md', 'lg', 'xl', true, false],
+      },
+    },
+  },
+};