@gitlab/ui 64.0.2 → 64.1.1

package/package.json

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

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

@@ -62,7 +62,7 @@ describe('base dropdown', () => {
       expect(autoUpdate).toHaveBeenCalledTimes(1);
     });
 
-    it("stops Floating UI's when closing the dropdown", async () => {
+    it('stops Floating UI when closing the dropdown', async () => {
       buildWrapper();
       await findDefaultDropdownToggle().trigger('click');
       await findDefaultDropdownToggle().trigger('click');
@@ -71,7 +71,7 @@ describe('base dropdown', () => {
       expect(mockStopAutoUpdate).toHaveBeenCalledTimes(1);
     });
 
-    it("restarts Floating UI's when reopening the dropdown", async () => {
+    it('restarts Floating UI when reopening the dropdown', async () => {
       buildWrapper();
       await findDefaultDropdownToggle().trigger('click');
       await findDefaultDropdownToggle().trigger('click');
@@ -103,6 +103,7 @@ describe('base dropdown', () => {
           findDropdownMenu().element,
           {
             placement: 'bottom-start',
+            strategy: 'absolute',
             middleware: [offset({ mainAxis: DEFAULT_OFFSET })],
           }
         );
@@ -115,7 +116,11 @@ describe('base dropdown', () => {
         expect(computePosition).toHaveBeenCalledWith(
           findDefaultDropdownToggle().element,
           findDropdownMenu().element,
-          { placement: 'bottom', middleware: [offset({ mainAxis: DEFAULT_OFFSET })] }
+          {
+            placement: 'bottom',
+            strategy: 'absolute',
+            middleware: [offset({ mainAxis: DEFAULT_OFFSET })],
+          }
         );
       });
 
@@ -126,7 +131,11 @@ describe('base dropdown', () => {
         expect(computePosition).toHaveBeenCalledWith(
           findDefaultDropdownToggle().element,
           findDropdownMenu().element,
-          { placement: 'bottom-end', middleware: [offset({ mainAxis: DEFAULT_OFFSET })] }
+          {
+            placement: 'bottom-end',
+            strategy: 'absolute',
+            middleware: [offset({ mainAxis: DEFAULT_OFFSET })],
+          }
         );
       });
 
@@ -143,10 +152,45 @@ describe('base dropdown', () => {
           findDropdownMenu().element,
           {
             placement: 'bottom-end',
+            strategy: 'absolute',
             middleware: [offset(customOffset)],
           }
         );
       });
+
+      describe('positioningStrategy', () => {
+        it('uses the absolute positioning strategy by default', async () => {
+          buildWrapper();
+
+          await findDefaultDropdownToggle().trigger('click');
+
+          expect(computePosition).toHaveBeenCalledWith(
+            findDefaultDropdownToggle().element,
+            findDropdownMenu().element,
+            expect.objectContaining({
+              strategy: 'absolute',
+            })
+          );
+          expect(findDropdownMenu().classes()).toContain('gl-absolute');
+        });
+
+        it('applies the fixed positioning strategy properly', async () => {
+          buildWrapper({
+            positioningStrategy: 'fixed',
+          });
+
+          await findDefaultDropdownToggle().trigger('click');
+
+          expect(computePosition).toHaveBeenCalledWith(
+            findDefaultDropdownToggle().element,
+            findDropdownMenu().element,
+            expect.objectContaining({
+              strategy: 'fixed',
+            })
+          );
+          expect(findDropdownMenu().classes()).toContain('gl-fixed');
+        });
+      });
     });
   });
 
@@ -291,6 +335,11 @@ describe('base dropdown', () => {
     });
 
     describe('toggle visibility', () => {
+      beforeEach(() => {
+        autoUpdate.mockImplementation(jest.requireActual('@floating-ui/dom').autoUpdate);
+        computePosition.mockImplementation(() => Promise.resolve);
+      });
+
       it('should toggle menu visibility on toggle click', async () => {
         const toggle = findCustomDropdownToggle();
         const firstToggleChild = findFirstToggleElement();

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

@@ -15,6 +15,8 @@ import {
   SPACE,
   ARROW_DOWN,
   GL_DROPDOWN_CONTENTS_CLASS,
+  POSITION_ABSOLUTE,
+  POSITION_FIXED,
 } from '../constants';
 import { logWarning, isElementTabbable, isElementFocusable } from '../../../../utils/utils';
 
@@ -133,11 +135,21 @@ export default {
       required: false,
       default: false,
     },
+    /**
+     * 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),
+    },
   },
   data() {
     return {
       visible: false,
-      openedYet: false,
       baseDropdownId: uniqueId('base-dropdown-'),
     };
   },
@@ -209,11 +221,17 @@ export default {
       return {
         'gl-display-block!': this.visible,
         [FIXED_WIDTH_CLASS]: !this.fluidWidth,
+        'gl-fixed': this.isFixed,
+        'gl-absolute': !this.isFixed,
       };
     },
+    isFixed() {
+      return this.positioningStrategy === POSITION_FIXED;
+    },
     floatingUIConfig() {
       return {
         placement: dropdownPlacements[this.placement],
+        strategy: this.positioningStrategy,
         middleware: [
           offset(this.offset),
           flip(),
@@ -263,7 +281,7 @@ export default {
         );
       }
     },
-    startFloating() {
+    async startFloating() {
       this.calculateNonScrollableAreaHeight();
       this.observer = new MutationObserver(this.calculateNonScrollableAreaHeight);
       this.observer.observe(this.$refs.content, {
@@ -272,24 +290,29 @@ export default {
         subtree: true,
       });
 
-      this.stopAutoUpdate = autoUpdate(this.toggleElement, this.$refs.content, async () => {
-        const { x, y } = await computePosition(
-          this.toggleElement,
-          this.$refs.content,
-          this.floatingUIConfig
-        );
+      await new Promise((resolve) => {
+        const stopAutoUpdate = autoUpdate(this.toggleElement, this.$refs.content, async () => {
+          const { x, y } = await computePosition(
+            this.toggleElement,
+            this.$refs.content,
+            this.floatingUIConfig
+          );
 
-        /**
-         * Due to the asynchronous nature of computePosition, it's technically possible for the
-         * component to have been destroyed by the time the promise resolves. In such case, we exit
-         * early to prevent a TypeError.
-         */
-        if (!this.$refs.content) return;
+          /**
+           * Due to the asynchronous nature of computePosition, it's technically possible for the
+           * component to have been destroyed by the time the promise resolves. In such case, we exit
+           * early to prevent a TypeError.
+           */
+          if (!this.$refs.content) return;
+
+          Object.assign(this.$refs.content.style, {
+            left: `${x}px`,
+            top: `${y}px`,
+          });
 
-        Object.assign(this.$refs.content.style, {
-          left: `${x}px`,
-          top: `${y}px`,
+          resolve(stopAutoUpdate);
         });
+        this.stopAutoUpdate = stopAutoUpdate;
       });
     },
     stopFloating() {
@@ -300,12 +323,16 @@ export default {
       this.visible = !this.visible;
 
       if (this.visible) {
+        // The dropdown needs to be actually visible before we compute its position with Floating UI.
+        await this.$nextTick();
+
         /**
-         * We defer the following logic to the next tick as all that comes next relies on the
-         * dropdown actually being visible.
+         * We wait until the dropdown's position has been computed before emitting the `shown` event.
+         * This ensures that, if the parent component attempts to focus an inner element, the dropdown
+         * is already properly placed in the page. Otherwise, the page would scroll back to the top.
          */
-        await this.$nextTick();
-        this.startFloating();
+        await this.startFloating();
+
         this.$emit(GL_DROPDOWN_SHOWN);
       } else {
         this.stopFloating();

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

@@ -11,4 +11,9 @@ export const ENTER = 'Enter';
 export const HOME = 'Home';
 export const SPACE = 'Space';
 
+// Positioning strategies
+// https://floating-ui.com/docs/computePosition#strategy
+export const POSITION_ABSOLUTE = 'absolute';
+export const POSITION_FIXED = 'fixed';
+
 export const GL_DROPDOWN_CONTENTS_CLASS = 'gl-new-dropdown-contents';

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.spec.js

@@ -10,6 +10,8 @@ import {
   ARROW_UP,
   HOME,
   END,
+  POSITION_ABSOLUTE,
+  POSITION_FIXED,
 } from '../constants';
 import GlDisclosureDropdown from './disclosure_dropdown.vue';
 import GlDisclosureDropdownItem from './disclosure_dropdown_item.vue';
@@ -345,4 +347,15 @@ describe('GlDisclosureDropdown', () => {
       expect(closeSpy).not.toHaveBeenCalled();
     });
   });
+
+  describe('positioningStrategy', () => {
+    it.each([POSITION_ABSOLUTE, POSITION_FIXED])(
+      'passes the %s positioning strategy to the base dropdown',
+      (positioningStrategy) => {
+        buildWrapper({ positioningStrategy });
+
+        expect(findBaseDropdown().props('positioningStrategy')).toBe(positioningStrategy);
+      }
+    );
+  });
 });

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.stories.js

@@ -41,6 +41,7 @@ const makeBindings = (overrides = {}) =>
     ':list-aria-labelled-by': 'listAriaLabelledBy',
     ':fluid-width': 'fluidWidth',
     ':auto-close': 'autoClose',
+    ':positioning-strategy': 'positioningStrategy',
     ...overrides,
   })
     .map(([key, value]) => `${key}="${value}"`)

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.vue

@@ -14,6 +14,8 @@ import {
   ARROW_DOWN,
   ARROW_UP,
   GL_DROPDOWN_CONTENTS_CLASS,
+  POSITION_ABSOLUTE,
+  POSITION_FIXED,
 } from '../constants';
 import {
   buttonCategoryOptions,
@@ -196,6 +198,17 @@ export default {
       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),
+    },
   },
   data() {
     return {
@@ -323,6 +336,7 @@ export default {
     :placement="placement"
     :offset="dropdownOffset"
     :fluid-width="fluidWidth"
+    :positioning-strategy="positioningStrategy"
     class="gl-disclosure-dropdown"
     @[$options.events.GL_DROPDOWN_SHOWN]="onShow"
     @[$options.events.GL_DROPDOWN_HIDDEN]="onHide"

package/src/components/base/new_dropdowns/dropdown.scss

@@ -20,7 +20,6 @@
     @include gl-border-gray-200;
     @include gl-rounded-lg;
     @include gl-shadow-md;
-    position: absolute;
     top: 0;
     left: 0;
     min-width: $gl-new-dropdown-min-width;

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

@@ -11,12 +11,14 @@ import {
   HOME,
   END,
   ENTER,
+  POSITION_ABSOLUTE,
+  POSITION_FIXED,
 } from '../constants';
 import GlIntersectionObserver from '../../../utilities/intersection_observer/intersection_observer.vue';
 import GlCollapsibleListbox, { ITEM_SELECTOR } from './listbox.vue';
 import GlListboxItem from './listbox_item.vue';
 import GlListboxGroup from './listbox_group.vue';
-import { mockOptions, mockGroups } from './mock_data';
+import { mockOptions, mockGroups, mockGroupsWithTextSrOnly } from './mock_data';
 
 jest.mock('@floating-ui/dom');
 autoUpdate.mockImplementation(() => {
@@ -396,14 +398,13 @@ describe('GlCollapsibleListbox', () => {
     });
 
     it('passes the `textSrOnly` prop', () => {
-      const mockGroupsWithTextSrOnly = JSON.parse(JSON.stringify(mockGroups));
-      mockGroupsWithTextSrOnly[0].textSrOnly = true;
-      mockGroupsWithTextSrOnly[1].textSrOnly = false;
       buildWrapper({ items: mockGroupsWithTextSrOnly });
 
       const groups = findListboxGroups();
 
-      const expectedTextSrOnlyProps = mockGroupsWithTextSrOnly.map((group) => group.textSrOnly);
+      const expectedTextSrOnlyProps = mockGroupsWithTextSrOnly.map(
+        (group) => group.textSrOnly ?? false
+      );
       const actualTextSrOnlyProps = groups.wrappers.map((group) => group.props('textSrOnly'));
 
       expect(actualTextSrOnlyProps).toEqual(expectedTextSrOnlyProps);
@@ -744,4 +745,15 @@ describe('GlCollapsibleListbox', () => {
       expect(findBaseDropdown().props('fluidWidth')).toBe(true);
     });
   });
+
+  describe('positioningStrategy', () => {
+    it.each([POSITION_ABSOLUTE, POSITION_FIXED])(
+      'passes the %s positioning strategy to the base dropdown',
+      (positioningStrategy) => {
+        buildWrapper({ positioningStrategy });
+
+        expect(findBaseDropdown().props('positioningStrategy')).toBe(positioningStrategy);
+      }
+    );
+  });
 });

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

@@ -24,7 +24,7 @@ import {
 } from '../../../../utils/stories_constants';
 import { POSITION } from '../../../utilities/truncate/constants';
 import readme from './listbox.md';
-import { mockOptions, mockGroups, mockUsers } from './mock_data';
+import { mockOptions, mockGroups, mockGroupsWithTextSrOnly, mockUsers } from './mock_data';
 import { flattenedOptions } from './utils';
 import GlCollapsibleListbox from './listbox.vue';
 
@@ -59,6 +59,7 @@ const generateProps = ({
   showSelectAllButtonLabel = defaultValue('showSelectAllButtonLabel'),
   startOpened = true,
   fluidWidth,
+  positioningStrategy,
 } = {}) => ({
   items,
   category,
@@ -88,6 +89,7 @@ const generateProps = ({
   showSelectAllButtonLabel,
   startOpened,
   fluidWidth,
+  positioningStrategy,
 });
 
 const makeBindings = (overrides = {}) =>
@@ -119,6 +121,7 @@ const makeBindings = (overrides = {}) =>
     ':reset-button-label': 'resetButtonLabel',
     ':show-select-all-button-label': 'showSelectAllButtonLabel',
     ':fluid-width': 'fluidWidth',
+    ':positioning-strategy': 'positioningStrategy',
     ...overrides,
   })
     .map(([key, value]) => `${key}="${value}"`)
@@ -459,6 +462,33 @@ export const CustomGroupsAndItems = makeGroupedExample({
   `),
 });
 
+export const GroupWithoutLabel = (args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  components: {
+    GlBadge,
+    GlCollapsibleListbox,
+  },
+  data() {
+    return {
+      selected: mockGroupsWithTextSrOnly[1].options[1].value,
+    };
+  },
+  mounted() {
+    if (this.startOpened) {
+      openListbox(this);
+    }
+  },
+  template: template(`
+    <template #list-item="{ item }">
+      {{ item.text }} <gl-badge v-if="item.value === 'main'" size="sm">default</gl-badge>
+    </template>
+  `),
+});
+GroupWithoutLabel.args = generateProps({
+  items: mockGroupsWithTextSrOnly,
+  headerText: 'Select branch',
+});
+
 export default {
   title: 'base/new-dropdowns/listbox',
   component: GlCollapsibleListbox,

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

@@ -12,6 +12,8 @@ import {
   ARROW_DOWN,
   ARROW_UP,
   GL_DROPDOWN_CONTENTS_CLASS,
+  POSITION_ABSOLUTE,
+  POSITION_FIXED,
 } from '../constants';
 import {
   buttonCategoryOptions,
@@ -318,6 +320,17 @@ export default {
       required: false,
       default: false,
     },
+    /**
+     * 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),
+    },
   },
   data() {
     return {
@@ -709,6 +722,7 @@ export default {
     :placement="placement"
     :offset="dropdownOffset"
     :fluid-width="fluidWidth"
+    :positioning-strategy="positioningStrategy"
     @[$options.events.GL_DROPDOWN_SHOWN]="onShow"
     @[$options.events.GL_DROPDOWN_HIDDEN]="onHide"
   >

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

@@ -67,6 +67,49 @@ export const mockGroups = [
   },
 ];
 
+export const mockGroupsWithTextSrOnly = [
+  {
+    text: 'Default',
+    options: [
+      {
+        text: 'main',
+        value: 'main',
+      },
+      {
+        text: 'development',
+        value: 'development',
+      },
+    ],
+    textSrOnly: true,
+  },
+  {
+    text: 'Feature branches',
+    options: [
+      {
+        text: 'feature/add-avatar',
+        value: 'add',
+      },
+      {
+        text: 'feature/improve-panel',
+        value: 'improve',
+      },
+    ],
+  },
+  {
+    text: 'Bugfix branches',
+    options: [
+      {
+        text: 'fix/border-of-avatar',
+        value: 'fix-border',
+      },
+      {
+        text: 'fix/radius-panel',
+        value: 'fix-radius',
+      },
+    ],
+  },
+];
+
 export const mockUsers = [
   {
     value: 'mikegreiling',