@gitlab/ui 52.6.1 → 52.7.1

package/package.json

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

package/scss_to_js/scss_variables.js

@@ -327,7 +327,6 @@ export const glDropdownWidth = '15rem'
 export const glDropdownWidthNarrow = '10rem'
 export const glDropdownWidthWide = '25rem'
 export const glMaxDropdownMaxHeight = '19.5rem'
-export const glBroadcastMessageTextMaxWidth = '58.375rem'
 export const glBroadcastMessageNotificationMaxWidth = '18.75rem'
 export const glModalSmallWidth = '32rem'
 export const glModalMediumWidth = '48rem'

package/scss_to_js/scss_variables.json

@@ -1745,11 +1745,6 @@
       "value": "px-to-rem(312px)",
       "compiledValue": "19.5rem"
     },
-    {
-      "name": "$gl-broadcast-message-text-max-width",
-      "value": "px-to-rem(934px)",
-      "compiledValue": "58.375rem"
-    },
     {
       "name": "$gl-broadcast-message-notification-max-width",
       "value": "px-to-rem(300px)",

package/src/components/base/broadcast_message/broadcast_message.scss

@@ -68,10 +68,6 @@
     @include gl-justify-content-center;
   }
 
-  &-text {
-    max-width: $gl-broadcast-message-text-max-width;
-  }
-
   &-icon {
     @include gl-mr-5;
 

package/src/components/base/broadcast_message/broadcast_message.vue

@@ -79,7 +79,7 @@ export default {
       <div class="gl-broadcast-message-icon gl-line-height-normal">
         <gl-icon :name="iconName" />
       </div>
-      <div class="gl-broadcast-message-text gl-my-n1">
+      <div class="gl-my-n1">
         <!-- @slot The broadcast message's text -->
         <slot></slot>
       </div>

package/src/components/base/new_dropdowns/listbox/listbox.spec.js

@@ -1,5 +1,6 @@
 import { mount } from '@vue/test-utils';
 import { nextTick } from 'vue';
+import { useMockIntersectionObserver } from '~/utils/use_mock_intersection_observer';
 import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
 import {
   GL_DROPDOWN_SHOWN,
@@ -9,6 +10,7 @@ import {
   HOME,
   END,
 } from '../constants';
+import GlIntersectionObserver from '../../../utilities/intersection_observer/intersection_observer.vue';
 import GlListbox, { ITEM_SELECTOR } from './listbox.vue';
 import GlListboxItem from './listbox_item.vue';
 import GlListboxGroup from './listbox_group.vue';
@@ -25,6 +27,8 @@ describe('GlListbox', () => {
     });
   };
 
+  useMockIntersectionObserver();
+
   const findBaseDropdown = () => wrapper.findComponent(GlBaseDropdown);
   const findListContainer = () => wrapper.find('[role="listbox"]');
   const findListboxItems = (root = wrapper) => root.findAllComponents(GlListboxItem);
@@ -36,6 +40,7 @@ describe('GlListbox', () => {
   const findLoadingIcon = () => wrapper.find("[data-testid='listbox-search-loader']");
   const findSRNumberOfResultsText = () => wrapper.find("[data-testid='listbox-number-of-results']");
   const findResetButton = () => wrapper.find("[data-testid='listbox-reset-button']");
+  const findIntersectionObserver = () => wrapper.findComponent(GlIntersectionObserver);
 
   describe('toggle text', () => {
     describe.each`
@@ -435,4 +440,125 @@ describe('GlListbox', () => {
       expect(wrapper.vm.closeAndFocus).toHaveBeenCalled();
     });
   });
+
+  describe('when `infiniteScroll` prop is `true`', () => {
+    it('should throw an error when items are groups', () => {
+      expect(() => {
+        buildWrapper({
+          items: mockGroups,
+          infiniteScroll: true,
+        });
+      }).toThrow(
+        'Infinite scroll does not support groups. Please set the "infiniteScroll" prop to "false"'
+      );
+      expect(wrapper).toHaveLoggedVueErrors();
+    });
+
+    it('renders `GlIntersectionObserver` component', () => {
+      buildWrapper({
+        headerText: 'Select assignee',
+        items: mockOptions,
+        infiniteScroll: true,
+      });
+
+      expect(findIntersectionObserver().exists()).toBe(true);
+    });
+
+    describe('when bottom of listbox is reached', () => {
+      it('emits `bottom-reached` event', () => {
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+        });
+
+        findIntersectionObserver().vm.$emit('appear');
+
+        expect(wrapper.emitted('bottom-reached')).toEqual([[]]);
+      });
+    });
+
+    describe('when `loading` prop is `true`', () => {
+      it('does not render `GlIntersectionObserver` component', () => {
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+          loading: true,
+        });
+
+        expect(findIntersectionObserver().exists()).toBe(false);
+      });
+    });
+
+    describe('when `searching` prop is `true`', () => {
+      it('does not render `GlIntersectionObserver` component', () => {
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+          searching: true,
+        });
+
+        expect(findIntersectionObserver().exists()).toBe(false);
+      });
+    });
+
+    describe('when `infiniteScrollLoading` prop is `true`', () => {
+      beforeEach(() => {
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+          infiniteScrollLoading: true,
+        });
+      });
+
+      it('shows loading icon', () => {
+        expect(wrapper.find('[data-testid="listbox-infinite-scroll-loader"]').exists()).toBe(true);
+      });
+
+      it('does not render `GlIntersectionObserver` component', () => {
+        expect(findIntersectionObserver().exists()).toBe(false);
+      });
+    });
+
+    describe('when `totalItems` prop is set', () => {
+      it('adds `aria-setsize` and `aria-posinset` attributes to listbox items', () => {
+        const totalItems = mockOptions.length;
+
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+          totalItems,
+        });
+
+        findListboxItems().wrappers.forEach((listboxItem, index) => {
+          expect(listboxItem.attributes('aria-setsize')).toBe(totalItems.toString());
+          expect(listboxItem.attributes('aria-posinset')).toBe((index + 1).toString());
+        });
+      });
+    });
+
+    describe('when `totalItems` prop is not set', () => {
+      it('does not add `aria-setsize` and `aria-posinset` attributes to listbox items', () => {
+        buildWrapper({
+          items: mockOptions,
+          infiniteScroll: true,
+        });
+
+        findListboxItems().wrappers.forEach((listboxItem) => {
+          expect(listboxItem.attributes('aria-setsize')).toBe(undefined);
+          expect(listboxItem.attributes('aria-posinset')).toBe(undefined);
+        });
+      });
+    });
+  });
+
+  describe('when `infiniteScroll` prop is `false`', () => {
+    it('does not render `GlIntersectionObserver` component', () => {
+      buildWrapper({
+        items: mockOptions,
+        infiniteScroll: false,
+      });
+
+      expect(findIntersectionObserver().exists()).toBe(false);
+    });
+  });
 });

package/src/components/base/new_dropdowns/listbox/listbox.stories.js

@@ -13,6 +13,8 @@ import {
   GlAvatar,
 } from '../../../../index';
 import { makeContainer } from '../../../../utils/story_decorators/container';
+import { disableControls } from '../../../../utils/stories_utils';
+import { setStoryTimeout } from '../../../../utils/test_utils';
 import readme from './listbox.md';
 import { mockOptions, mockGroups } from './mock_data';
 import { flattenedOptions } from './utils';
@@ -28,6 +30,8 @@ const generateProps = ({
   loading = defaultValue('loading'),
   searchable = defaultValue('searchable'),
   searching = defaultValue('searching'),
+  infiniteScroll = defaultValue('infiniteScroll'),
+  infiniteScrollLoading = defaultValue('infiniteScrollLoading'),
   noResultsText = defaultValue('noResultsText'),
   searchPlaceholder = defaultValue('searchPlaceholder'),
   noCaret = defaultValue('noCaret'),
@@ -51,6 +55,8 @@ const generateProps = ({
   loading,
   searchable,
   searching,
+  infiniteScroll,
+  infiniteScrollLoading,
   noResultsText,
   searchPlaceholder,
   noCaret,
@@ -77,6 +83,8 @@ const makeBindings = (overrides = {}) =>
     ':loading': 'loading',
     ':searchable': 'searchable',
     ':searching': 'searching',
+    ':infinite-scroll': 'infiniteScroll',
+    ':infinite-scroll-loading': 'infiniteScrollLoading',
     ':no-results-text': 'noResultsText',
     ':search-placeholder': 'searchPlaceholder',
     ':no-caret': 'noCaret',
@@ -534,3 +542,56 @@ SearchableGroups.args = generateProps({
   items: mockGroups,
 });
 SearchableGroups.decorators = [makeContainer({ height: '370px' })];
+
+export const InfiniteScroll = (
+  args,
+  { argTypes: { infiniteScroll, infiniteScrollLoading, items, ...argTypes } }
+) => ({
+  props: Object.keys(argTypes),
+  components: {
+    GlListbox,
+  },
+  data() {
+    return {
+      selected: mockOptions[1].value,
+      items: mockOptions.slice(0, 10),
+      infiniteScrollLoading: false,
+      infiniteScroll: true,
+    };
+  },
+  mounted() {
+    if (this.startOpened) {
+      openListbox(this);
+    }
+  },
+  methods: {
+    onBottomReached() {
+      this.infiniteScrollLoading = true;
+
+      setStoryTimeout(() => {
+        this.items.push(...mockOptions.slice(10, 12));
+        this.infiniteScrollLoading = false;
+        this.infiniteScroll = false;
+      }, 1000);
+    },
+  },
+  template: template('', {
+    label: `<span class="gl-my-0" id="listbox-label">Select a department</span>`,
+    bindingOverrides: {
+      ':items': 'items',
+      ':infinite-scroll': 'infiniteScroll',
+      ':infinite-scroll-loading': 'infiniteScrollLoading',
+      ':total-items': 12,
+      '@bottom-reached': 'onBottomReached',
+    },
+  }),
+});
+
+InfiniteScroll.argTypes = {
+  ...disableControls(['infiniteScroll', 'infiniteScrollLoading', 'items']),
+};
+InfiniteScroll.parameters = {
+  storyshots: { disable: true },
+};
+InfiniteScroll.args = generateProps();
+InfiniteScroll.decorators = [makeContainer({ height: '370px' })];

package/src/components/base/new_dropdowns/listbox/listbox.vue

@@ -17,6 +17,7 @@ import {
 } from '../../../../utils/constants';
 import GlButton from '../../button/button.vue';
 import GlLoadingIcon from '../../loading_icon/loading_icon.vue';
+import GlIntersectionObserver from '../../../utilities/intersection_observer/intersection_observer.vue';
 import GlSearchBoxByType from '../../search_box_by_type/search_box_by_type.vue';
 import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
 import GlListboxItem from './listbox_item.vue';
@@ -43,6 +44,7 @@ export default {
     GlSearchBoxByType,
     GlListboxSearchInput,
     GlLoadingIcon,
+    GlIntersectionObserver,
   },
   model: {
     prop: 'selected',
@@ -215,6 +217,37 @@ export default {
       required: false,
       default: false,
     },
+    /**
+     * Enables infinite scroll.
+     * When set to `true`, the `@bottom-reached` event will be fired when
+     * the bottom of the listbox is scrolled to.
+     * Does not support groups.
+     */
+    infiniteScroll: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * This prop is used for infinite scroll.
+     * It represents the total number of items that exist,
+     * even if they have not yet been loaded.
+     * Do not set this prop if the total number of items is unknown.
+     */
+    totalItems: {
+      type: Number,
+      required: false,
+      default: null,
+    },
+    /**
+     * This prop is used for infinite scroll.
+     * Set to `true` when more items are being loaded.
+     */
+    infiniteScrollLoading: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
     /**
      * Message to be displayed when filtering produced no results
      */
@@ -298,6 +331,9 @@ export default {
       }
       return Boolean(this.selected);
     },
+    showIntersectionObserver() {
+      return this.infiniteScroll && !this.infiniteScrollLoading && !this.loading && !this.searching;
+    },
   },
   watch: {
     selected: {
@@ -324,6 +360,17 @@ export default {
       },
     },
   },
+  created() {
+    if (
+      process.env.NODE_ENV !== 'production' &&
+      this.infiniteScroll &&
+      this.items.some((item) => !isOption(item))
+    ) {
+      throw new Error(
+        'Infinite scroll does not support groups. Please set the "infiniteScroll" prop to "false"'
+      );
+    }
+  },
   methods: {
     open() {
       this.$refs.baseDropdown.open();
@@ -467,6 +514,25 @@ export default {
     closeAndFocus() {
       this.$refs.baseDropdown.closeAndFocus();
     },
+    onIntersectionObserverAppear() {
+      /**
+       * Emitted when bottom of listbox has been scrolled to.
+       * Used for infinite scroll.
+       *
+       * @event bottom-reached
+       */
+      this.$emit('bottom-reached');
+    },
+    listboxItemMoreItemsAriaAttributes(index) {
+      if (this.totalItems === null) {
+        return {};
+      }
+
+      return {
+        'aria-setsize': this.totalItems,
+        'aria-posinset': index + 1,
+      };
+    },
     isOption,
   },
 };
@@ -551,6 +617,7 @@ export default {
             :is-selected="isSelected(item)"
             :is-focused="isFocused(item)"
             :is-check-centered="isCheckCentered"
+            v-bind="listboxItemMoreItemsAriaAttributes(index)"
             @select="onSelect(item, $event)"
           >
             <!-- @slot Custom template of the listbox item -->
@@ -583,8 +650,17 @@ export default {
           </gl-listbox-group>
         </template>
       </template>
+      <gl-intersection-observer
+        v-if="showIntersectionObserver"
+        @appear="onIntersectionObserverAppear"
+      />
     </component>
-
+    <gl-loading-icon
+      v-if="infiniteScrollLoading"
+      data-testid="listbox-infinite-scroll-loader"
+      size="md"
+      class="gl-my-3"
+    />
     <span
       v-if="announceSRSearchResults"
       data-testid="listbox-number-of-results"

package/src/scss/variables.scss

@@ -462,7 +462,6 @@ $gl-dropdown-width-wide: px-to-rem(400px);
 $gl-max-dropdown-max-height: px-to-rem(312px);
 
 // Broadcast messages
-$gl-broadcast-message-text-max-width: px-to-rem(934px);
 $gl-broadcast-message-notification-max-width: px-to-rem(300px);
 
 // Modal Widths