@gitlab/ui 64.1.0 → 64.1.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [64.1.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v64.1.0...v64.1.1) (2023-06-01)
+
+
+### Bug Fixes
+
+* **dropdowns:** auto-focus only once dropdown is properly positioned ([fe6c39d](https://gitlab.com/gitlab-org/gitlab-ui/commit/fe6c39dee065cbbc35dd225ea0e565dba368af14))
+
 # [64.1.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v64.0.2...v64.1.0) (2023-05-30)
 
 

package/dist/components/base/new_dropdowns/base_dropdown/base_dropdown.js

@@ -138,7 +138,6 @@ var script = {
   data() {
     return {
       visible: false,
-      openedYet: false,
       baseDropdownId: uniqueId('base-dropdown-')
     };
   },
@@ -264,7 +263,7 @@ var script = {
           Use 'a' or 'button' element instead or make sure to add 'role="button"' along with 'tabindex' otherwise.`, this.$el);
       }
     },
-    startFloating() {
+    async startFloating() {
       this.calculateNonScrollableAreaHeight();
       this.observer = new MutationObserver(this.calculateNonScrollableAreaHeight);
       this.observer.observe(this.$refs.content, {
@@ -272,22 +271,26 @@ var script = {
         childList: true,
         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;
-        Object.assign(this.$refs.content.style, {
-          left: `${x}px`,
-          top: `${y}px`
+          /**
+           * 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`
+          });
+          resolve(stopAutoUpdate);
         });
+        this.stopAutoUpdate = stopAutoUpdate;
       });
     },
     stopFloating() {
@@ -298,12 +301,15 @@ var script = {
     async toggle() {
       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/dist/components/base/new_dropdowns/listbox/mock_data.js

@@ -57,6 +57,35 @@ const mockGroups = [{
     value: 'v2.1'
   }]
 }];
+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'
+  }]
+}];
 const mockUsers = [{
   value: 'mikegreiling',
   text: 'Mike Greiling',
@@ -74,4 +103,4 @@ const mockUsers = [{
   icon: 'bin'
 }];
 
-export { mockGroups, mockOptions, mockUsers };
+export { mockGroups, mockGroupsWithTextSrOnly, mockOptions, mockUsers };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "64.1.0",
+  "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');
@@ -335,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

@@ -150,7 +150,6 @@ export default {
   data() {
     return {
       visible: false,
-      openedYet: false,
       baseDropdownId: uniqueId('base-dropdown-'),
     };
   },
@@ -282,7 +281,7 @@ export default {
         );
       }
     },
-    startFloating() {
+    async startFloating() {
       this.calculateNonScrollableAreaHeight();
       this.observer = new MutationObserver(this.calculateNonScrollableAreaHeight);
       this.observer.observe(this.$refs.content, {
@@ -291,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() {
@@ -319,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/listbox/listbox.spec.js

@@ -18,7 +18,7 @@ import GlIntersectionObserver from '../../../utilities/intersection_observer/int
 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(() => {
@@ -398,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);

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';
 
@@ -462,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/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',