@gitlab/ui 39.3.2 → 39.4.0

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

@@ -0,0 +1,348 @@
+<script>
+import { clamp, uniqueId } from 'lodash';
+import { stopEvent } from '../../../../utils/utils';
+import {
+  GL_DROPDOWN_SHOWN,
+  GL_DROPDOWN_HIDDEN,
+  HOME,
+  END,
+  ARROW_DOWN,
+  ARROW_UP,
+} from '../constants';
+import {
+  buttonCategoryOptions,
+  buttonSizeOptions,
+  dropdownVariantOptions,
+} from '../../../../utils/constants';
+import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
+import GlListboxItem from './listbox_item.vue';
+
+export const ITEM_SELECTOR = '[role="option"]';
+
+export default {
+  events: {
+    GL_DROPDOWN_SHOWN,
+    GL_DROPDOWN_HIDDEN,
+  },
+  components: {
+    GlBaseDropdown,
+    GlListboxItem,
+  },
+  model: {
+    prop: 'selected',
+    event: 'select',
+  },
+  props: {
+    /**
+     * Items to display in the dropdown
+     */
+    items: {
+      type: Array,
+      required: false,
+      default: () => [],
+      validator: (items) => {
+        return items.every(({ value }) => typeof value === 'string');
+      },
+    },
+    /**
+     * array of selected items values for multi-select and selected item value for single-select
+     */
+    selected: {
+      type: [Array, String, Number],
+      required: false,
+      default: () => [],
+    },
+    /**
+     * Allow multi-selection
+     */
+    multiple: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Toggle button text
+     */
+    toggleText: {
+      type: String,
+      required: false,
+      default: '',
+    },
+    /**
+     * Toggle text to be read by screen readers only
+     */
+    textSrOnly: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Styling option - dropdown's toggle category
+     */
+    category: {
+      type: String,
+      required: false,
+      default: buttonCategoryOptions.primary,
+      validator: (value) => Object.keys(buttonCategoryOptions).includes(value),
+    },
+    /**
+     * Styling option - dropdown's toggle variant
+     */
+    variant: {
+      type: String,
+      required: false,
+      default: dropdownVariantOptions.default,
+      validator: (value) => Object.keys(dropdownVariantOptions).includes(value),
+    },
+    /**
+     * The size of the dropdown toggle
+     */
+    size: {
+      type: String,
+      required: false,
+      default: buttonSizeOptions.medium,
+      validator: (value) => Object.keys(buttonSizeOptions).includes(value),
+    },
+    /**
+     * Icon name that will be rendered in the toggle button
+     */
+    icon: {
+      type: String,
+      required: false,
+      default: '',
+    },
+    /**
+     * Set to "true" to disable the dropdown
+     */
+    disabled: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Set to "true" when dropdown content (items) is loading
+     */
+    loading: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Additional CSS classes to customize toggle appearance
+     */
+    toggleClass: {
+      type: [String, Array, Object],
+      required: false,
+      default: null,
+    },
+    /**
+     * Set to "true" to hide the caret
+     */
+    noCaret: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * Right align listbox menu with respect to the toggle button
+     */
+    right: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
+    /**
+     * The `aria-labelledby` attribute value for the toggle button
+     */
+    ariaLabelledby: {
+      type: String,
+      required: false,
+      default: null,
+    },
+  },
+  data() {
+    return {
+      selectedValues: [],
+      toggleId: uniqueId('dropdown-toggle-btn-'),
+      nextFocusedItemIndex: null,
+    };
+  },
+  computed: {
+    listboxToggleText() {
+      if (!this.toggleText) {
+        if (!this.multiple && this.selectedValues.length) {
+          return this.items.find(({ value }) => value === this.selectedValues[0])?.text;
+        }
+        return '';
+      }
+
+      return this.toggleText;
+    },
+    selectedIndices() {
+      return this.selectedValues
+        .map((selected) => this.items.findIndex(({ value }) => value === selected))
+        .sort();
+    },
+  },
+  watch: {
+    selected: {
+      immediate: true,
+      handler(newSelected) {
+        if (Array.isArray(newSelected)) {
+          if (!this.multiple && newSelected.length) {
+            throw new Error('To allow multi-selection, please, set "multiple" property to "true"');
+          }
+          this.selectedValues = [...newSelected];
+        } else {
+          this.selectedValues = [newSelected];
+        }
+      },
+    },
+  },
+  methods: {
+    onShow() {
+      this.$nextTick(() => {
+        this.focusItem(this.selectedIndices[0] ?? 0, this.getFocusableListItemElements());
+        /**
+         * Emitted when dropdown is shown
+         *
+         * @event shown
+         */
+        this.$emit(GL_DROPDOWN_SHOWN);
+      });
+    },
+    onHide() {
+      /**
+       * Emitted when dropdown is hidden
+       *
+       * @event hidden
+       */
+      this.$emit(GL_DROPDOWN_HIDDEN);
+      this.nextFocusedItemIndex = null;
+    },
+    onKeydown(event) {
+      const { code } = event;
+      const elements = this.getFocusableListItemElements();
+
+      if (elements.length < 1) return;
+
+      let stop = true;
+
+      if (code === HOME) {
+        this.focusItem(0, elements);
+      } else if (code === END) {
+        this.focusItem(elements.length - 1, elements);
+      } else if (code === ARROW_UP) {
+        this.focusNextItem(event, elements, -1);
+      } else if (code === ARROW_DOWN) {
+        this.focusNextItem(event, elements, 1);
+      } else {
+        stop = false;
+      }
+
+      if (stop) {
+        stopEvent(event);
+      }
+    },
+    getFocusableListItemElements() {
+      const items = this.$refs.list.querySelectorAll(ITEM_SELECTOR);
+      return Array.from(items);
+    },
+    focusNextItem(event, elements, offset) {
+      const { target } = event;
+      const currentIndex = elements.indexOf(target);
+      const nextIndex = clamp(currentIndex + offset, 0, elements.length - 1);
+
+      this.focusItem(nextIndex, elements);
+    },
+    focusItem(index, elements) {
+      this.nextFocusedItemIndex = index;
+
+      this.$nextTick(() => {
+        elements[index]?.focus();
+      });
+    },
+    onSelect({ value }, isSelected) {
+      if (this.multiple) {
+        this.onMultiSelect(value, isSelected);
+      } else {
+        this.onSingleSelect(value, isSelected);
+      }
+    },
+    isSelected(item) {
+      return this.selectedValues.some((value) => value === item.value);
+    },
+    onSingleSelect(value, isSelected) {
+      if (isSelected) {
+        /**
+         * Emitted when selection is changed
+         *
+         * @event select
+         */
+        this.$emit('select', value);
+      }
+
+      this.$refs.baseDropdown.closeAndFocus();
+    },
+    onMultiSelect(value, isSelected) {
+      if (isSelected) {
+        this.$emit('select', [...this.selectedValues, value]);
+      } else {
+        this.$emit(
+          'select',
+          this.selectedValues.filter((selectedValue) => selectedValue !== value)
+        );
+      }
+    },
+  },
+};
+</script>
+
+<template>
+  <gl-base-dropdown
+    ref="baseDropdown"
+    aria-haspopup="listbox"
+    :aria-labelledby="ariaLabelledby"
+    :toggle-id="toggleId"
+    :toggle-text="listboxToggleText"
+    :toggle-class="toggleClass"
+    :text-sr-only="textSrOnly"
+    :category="category"
+    :variant="variant"
+    :size="size"
+    :icon="icon"
+    :disabled="disabled"
+    :loading="loading"
+    :no-caret="noCaret"
+    :right="right"
+    @[$options.events.GL_DROPDOWN_SHOWN]="onShow"
+    @[$options.events.GL_DROPDOWN_HIDDEN]="onHide"
+  >
+    <!-- @slot Content to display in dropdown header -->
+    <slot name="header"></slot>
+
+    <ul
+      ref="list"
+      :aria-labelledby="toggleId"
+      role="listbox"
+      class="gl-new-dropdown-contents gl-list-style-none gl-pl-0 gl-mb-0"
+      tabindex="-1"
+      @keydown="onKeydown"
+    >
+      <gl-listbox-item
+        v-for="(item, index) in items"
+        :key="item.value"
+        :is-selected="isSelected(item)"
+        :is-focused="nextFocusedItemIndex === index"
+        @select="onSelect(item, $event)"
+      >
+        <!-- @slot Custom template of the listbox item -->
+        <slot name="list-item" :item="item">
+          {{ item.text }}
+        </slot>
+      </gl-listbox-item>
+    </ul>
+    <!-- @slot Content to display in dropdown footer -->
+    <slot name="footer"></slot>
+  </gl-base-dropdown>
+</template>

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

@@ -0,0 +1,104 @@
+import { mount } from '@vue/test-utils';
+import GLIcon from '../../icon/icon.vue';
+
+import { ENTER, SPACE } from '../constants';
+import GlListboxItem from './listbox_item.vue';
+
+describe('GlListboxItem', () => {
+  let wrapper;
+
+  const buildWrapper = (propsData, slots = {}) => {
+    wrapper = mount(GlListboxItem, {
+      propsData,
+      slots,
+    });
+  };
+  const findItem = () => wrapper.find('[role="option"]');
+  const findCheckIcon = () => findItem().findComponent(GLIcon);
+
+  describe('toggleSelection', () => {
+    describe('when selected ', () => {
+      beforeEach(() => {
+        buildWrapper({ isSelected: true });
+      });
+
+      it('should set `aria-selected` attribute on the list item to `true`', () => {
+        expect(findItem().attributes('aria-selected')).toBe('true');
+      });
+
+      it('should display check icon', () => {
+        expect(findCheckIcon().classes()).not.toContain('gl-visibility-hidden');
+      });
+
+      it('should emit the `select` event when clicked', async () => {
+        await findItem().trigger('click');
+        expect(wrapper.emitted('select')[0][0]).toBe(false);
+      });
+
+      it('should emit the `select` event on `ENTER` keydown event', async () => {
+        await findItem().trigger('click');
+        findItem().trigger('keydown', { code: SPACE });
+        expect(wrapper.emitted('select')[0][0]).toBe(false);
+      });
+
+      it('should emit the `select` event on `SPACE` keydown event', async () => {
+        await findItem().trigger('click');
+        findItem().trigger('keydown', { code: SPACE });
+        expect(wrapper.emitted('select')[0][0]).toBe(false);
+      });
+    });
+
+    describe('when not selected ', () => {
+      beforeEach(() => {
+        buildWrapper({ isSelected: false });
+      });
+
+      it('should set `aria-selected` attribute on the list item to `false`', () => {
+        expect(findItem().attributes('aria-selected')).toBeUndefined();
+      });
+
+      it('should not  display check icon', () => {
+        expect(findCheckIcon().classes()).toContain('gl-visibility-hidden');
+      });
+
+      it('should emit the `select` event when clicked', async () => {
+        await findItem().trigger('click');
+        expect(wrapper.emitted('select')[0][0]).toBe(true);
+      });
+
+      it('should emit the `select` event on `ENTER` keydown event', async () => {
+        await findItem().trigger('click');
+        findItem().trigger('keydown', { code: ENTER });
+        expect(wrapper.emitted('select')[0][0]).toBe(true);
+      });
+
+      it('should emit the `select` event on `SPACE` keydown event', async () => {
+        await findItem().trigger('click');
+        findItem().trigger('keydown', { code: SPACE });
+        expect(wrapper.emitted('select')[0][0]).toBe(true);
+      });
+    });
+  });
+
+  describe('tabindex', () => {
+    it('should set tabindex to `-1` when item is not focused', () => {
+      buildWrapper({ isFocused: false });
+      expect(wrapper.attributes('tabindex')).toBe('-1');
+    });
+
+    it('should set tabindex to `0` when item is focused', () => {
+      buildWrapper({ isFocused: true });
+      expect(wrapper.attributes('tabindex')).toBe('0');
+    });
+  });
+
+  describe('when default slot content provided', () => {
+    const content = 'This is an item';
+    const slots = { default: content };
+
+    it('renders it', () => {
+      buildWrapper({}, slots);
+      expect(wrapper.text()).toContain(content);
+    });
+  });
+});

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

@@ -0,0 +1,59 @@
+<script>
+import GlIcon from '../../icon/icon.vue';
+import { ENTER, SPACE } from '../constants';
+import { stopEvent } from '../../../../utils/utils';
+
+export default {
+  components: {
+    GlIcon,
+  },
+  props: {
+    isSelected: {
+      type: Boolean,
+      default: false,
+      required: false,
+    },
+    isFocused: {
+      type: Boolean,
+      default: false,
+      required: false,
+    },
+  },
+  methods: {
+    toggleSelection() {
+      this.$emit('select', !this.isSelected);
+    },
+    onKeydown(event) {
+      const { code } = event;
+
+      if (code === ENTER || code === SPACE) {
+        stopEvent(event);
+        this.toggleSelection();
+      }
+    },
+  },
+};
+</script>
+
+<template>
+  <li
+    class="gl-new-dropdown-item"
+    role="option"
+    :tabindex="isFocused ? 0 : -1"
+    :aria-selected="isSelected"
+    @click="toggleSelection"
+    @keydown="onKeydown"
+  >
+    <span class="dropdown-item">
+      <gl-icon
+        name="mobile-issue-close"
+        data-testid="dropdown-item-checkbox"
+        class="gl-mt-3 gl-align-self-start"
+        :class="['gl-new-dropdown-item-check-icon', { 'gl-visibility-hidden': !isSelected }]"
+      />
+      <span class="gl-new-dropdown-item-text-wrapper">
+        <slot></slot>
+      </span>
+    </span>
+  </li>
+</template>

package/src/index.js

@@ -54,6 +54,10 @@ export { default as GlDropdownSectionHeader } from './components/base/dropdown/d
 export { default as GlDropdownDivider } from './components/base/dropdown/dropdown_divider.vue';
 export { default as GlDropdownText } from './components/base/dropdown/dropdown_text.vue';
 export { default as GlDropdown } from './components/base/dropdown/dropdown.vue';
+// new components aiming to replace GlDropdown  - start
+export { default as GlListbox } from './components/base/new_dropdowns/listbox/listbox.vue';
+export { default as GlListboxItem } from './components/base/new_dropdowns/listbox/listbox_item.vue';
+// new components aiming to replace GlDropdown  - end
 export { default as GlPath } from './components/base/path/path.vue';
 export { default as GlTable } from './components/base/table/table.vue';
 export { default as GlBreadcrumb } from './components/base/breadcrumb/breadcrumb.vue';

package/src/utils/utils.js

@@ -122,3 +122,21 @@ export function logWarning(message = '') {
     console.warn(message); // eslint-disable-line no-console
   }
 }
+
+/**
+ * Stop default event handling and propagation
+ */
+export function stopEvent(
+  event,
+  { preventDefault = true, stopPropagation = true, stopImmediatePropagation = false } = {}
+) {
+  if (preventDefault) {
+    event.preventDefault();
+  }
+  if (stopPropagation) {
+    event.stopPropagation();
+  }
+  if (stopImmediatePropagation) {
+    event.stopImmediatePropagation();
+  }
+}

package/src/utils/utils.spec.js

@@ -1,4 +1,4 @@
-import { isElementFocusable, focusFirstFocusableElement } from './utils';
+import { isElementFocusable, focusFirstFocusableElement, stopEvent } from './utils';
 
 describe('isElementFocusable', () => {
   const myBtn = () => document.querySelector('button');
@@ -77,3 +77,43 @@ describe('focusFirstFocusableElement', () => {
     expect(document.activeElement).toBe(myInput());
   });
 });
+
+describe('stopEvent', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  const event = {
+    preventDefault: jest.fn(),
+    stopPropagation: jest.fn(),
+    stopImmediatePropagation: jest.fn(),
+  };
+
+  it('calls preventDefault and stopPropagation by default', () => {
+    stopEvent(event);
+
+    expect(event.preventDefault).toHaveBeenCalledTimes(1);
+    expect(event.stopPropagation).toHaveBeenCalledTimes(1);
+    expect(event.stopImmediatePropagation).not.toHaveBeenCalled();
+  });
+
+  it('completely stops the event when stopImmediatePropagation is true', () => {
+    stopEvent(event, { stopImmediatePropagation: true });
+
+    expect(event.preventDefault).toHaveBeenCalledTimes(1);
+    expect(event.stopPropagation).toHaveBeenCalledTimes(1);
+    expect(event.stopImmediatePropagation).toHaveBeenCalledTimes(1);
+  });
+
+  it('calls event stop methods set to true', () => {
+    stopEvent(event, {
+      preventDefault: false,
+      stopPropagation: false,
+      stopImmediatePropagation: true,
+    });
+
+    expect(event.preventDefault).not.toHaveBeenCalled();
+    expect(event.stopPropagation).not.toHaveBeenCalled();
+    expect(event.stopImmediatePropagation).toHaveBeenCalledTimes(1);
+  });
+});