@gitlab/ui 35.0.0 → 36.2.0

package/src/components/base/filtered_search/filtered_search_token_segment.stories.js

@@ -1,7 +1,7 @@
 import { withKnobs, boolean } from '@storybook/addon-knobs';
 import PortalVue from 'portal-vue';
 import Vue from 'vue';
-import { GlFilteredSearchSuggestion } from '../../../../index';
+import { GlFilteredSearchSuggestion } from '../../../index';
 import { documentedStoriesOf } from '../../../../documentation/documented_stories';
 import { provide } from './common_story_options';
 import readme from './filtered_search_term.md';

package/src/components/base/filtered_search/filtered_search_token_segment.vue

@@ -49,6 +49,16 @@ export default {
       required: true,
       validator: () => true,
     },
+    searchInputAttributes: {
+      type: Object,
+      required: false,
+      default: () => ({}),
+    },
+    isLastToken: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
   },
 
   data() {
@@ -244,6 +254,7 @@ export default {
 
 <template>
   <div
+    v-bind="isLastToken && !active && searchInputAttributes"
     class="gl-filtered-search-token-segment"
     :class="{ 'gl-filtered-search-token-segment-active': active }"
     data-testid="filtered-search-token-segment"
@@ -252,6 +263,7 @@ export default {
     <template v-if="active">
       <input
         ref="input"
+        v-bind="searchInputAttributes"
         v-model="inputValue"
         class="gl-filtered-search-token-segment-input"
         :aria-label="label"

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

@@ -5,7 +5,7 @@ import {
   GlFormSelect,
   GlFormCheckbox,
   GlButton,
-} from '../../../../index';
+} from '../../../index';
 import { setStoryTimeout } from '../../../utils/test_utils';
 import readme from './form.md';
 

package/src/components/base/form/form_checkbox/form_checkbox.stories.js

@@ -1,4 +1,4 @@
-import { GlFormCheckbox, GlFormCheckboxGroup } from '../../../../../index';
+import { GlFormCheckbox, GlFormCheckboxGroup } from '../../../../index';
 import readme from './form_checkbox.md';
 
 const components = {

package/src/components/base/form/form_group/form_group.stories.js

@@ -1,6 +1,6 @@
 import { withKnobs, text, select, boolean } from '@storybook/addon-knobs';
 import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
-import { GlFormGroup, GlFormInput, GlFormTextarea } from '../../../../../index';
+import { GlFormGroup, GlFormInput, GlFormTextarea } from '../../../../index';
 import { sizeOptions } from '../../../../utils/constants';
 import readme from './form_group.md';
 

package/src/components/base/form/form_input/form_input.stories.js

@@ -1,4 +1,4 @@
-import { GlFormInput } from '../../../../../index';
+import { GlFormInput } from '../../../../index';
 import { formInputSizes } from '../../../../utils/constants';
 import readme from './form_input.md';
 

package/src/components/base/form/form_input_group/form_input_group.stories.js

@@ -1,6 +1,6 @@
 import { withKnobs, boolean, object, text } from '@storybook/addon-knobs';
 import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
-import { GlFormInputGroup, GlInputGroupText } from '../../../../../index';
+import { GlFormInputGroup, GlInputGroupText } from '../../../../index';
 import readme from './form_input_group.md';
 
 const components = {

package/src/components/base/form/form_radio/form_radio.stories.js

@@ -1,4 +1,4 @@
-import { GlFormRadio } from '../../../../../index';
+import { GlFormRadio } from '../../../../index';
 import readme from './form_radio.md';
 
 const defaultOptions = [

package/src/components/base/form/form_radio_group/form_radio_group.stories.js

@@ -1,6 +1,6 @@
 import { withKnobs, object, text } from '@storybook/addon-knobs';
 import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
-import { GlFormRadioGroup, GlFormRadio } from '../../../../../index';
+import { GlFormRadioGroup, GlFormRadio } from '../../../../index';
 import readme from './form_radio_group.md';
 
 const components = {

package/src/components/base/form/form_select/form_select.stories.js

@@ -1,4 +1,4 @@
-import { GlFormSelect } from '../../../../../index';
+import { GlFormSelect } from '../../../../index';
 import { sizeOptions, formStateOptions } from '../../../../utils/constants';
 import { formSelectOptions } from './constants';
 import readme from './form_select.md';

package/src/components/base/form/form_text/form_text.vue

@@ -1,3 +1,5 @@
 <script>
-export { BFormText as default } from 'bootstrap-vue';
+import { BFormText } from 'bootstrap-vue';
+
+export default BFormText;
 </script>

package/src/components/base/form/form_textarea/form_textarea.stories.js

@@ -1,4 +1,4 @@
-import { GlFormTextarea } from '../../../../../index';
+import { GlFormTextarea } from '../../../../index';
 import readme from './form_textarea.md';
 
 const template = `

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

@@ -1,5 +1,5 @@
 import iconSpriteInfo from '@gitlab/svgs/dist/icons.json';
-import { GlIcon } from '../../../../index';
+import { GlIcon } from '../../../index';
 import { iconSizeOptions } from '../../../utils/constants';
 import readme from './icon.md';
 

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

@@ -1,5 +1,5 @@
 import { setStoryTimeout } from '../../../utils/test_utils';
-import { GlInfiniteScroll } from '../../../../index';
+import { GlInfiniteScroll } from '../../../index';
 import readme from './infinite_scroll.md';
 
 const ITEMS_BATCH_SIZE = 20;

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

@@ -1,4 +1,4 @@
-import { GlLabel } from '../../../../index';
+import { GlLabel } from '../../../index';
 import { labelSizeOptions, tooltipPlacements } from '../../../utils/constants';
 import readme from './label.md';
 

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

@@ -1,4 +1,4 @@
-import { GlLink } from '../../../../index';
+import { GlLink } from '../../../index';
 import { targetOptions } from '../../../utils/constants';
 import readme from './link.md';
 

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

@@ -1,4 +1,4 @@
-import { GlLoadingIcon } from '../../../../index';
+import { GlLoadingIcon } from '../../../index';
 import { viewModeOptions, loadingIconSizes } from '../../../utils/constants';
 import readme from './loading_icon.md';
 

package/src/components/base/modal/modal.scss

@@ -53,7 +53,8 @@ body.modal-open {
 
   .modal-header {
     @include gl-bg-white;
-    @include gl-pr-3;
+    @include gl-pb-3;
+    @include gl-border-none;
 
     .modal-title {
       @include gl-font-lg;
@@ -68,6 +69,7 @@ body.modal-open {
     @include gl-bg-white;
     @include gl-relative;
     @include gl-p-5;
+    @include gl-py-3;
     @include gl-text-left;
     @include gl-white-space-normal;
     @include gl-font-base;
@@ -78,7 +80,8 @@ body.modal-open {
     @include gl-display-flex;
     @include gl-flex-direction-row;
     @include gl-p-5;
-    @include gl-bg-gray-10;
+    @include gl-pt-3;
+    @include gl-border-none;
 
     .btn {
       @include gl-m-0;

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

@@ -1,4 +1,4 @@
-import { GlModal, GlModalDirective, GlButton } from '../../../../index';
+import { GlModal, GlModalDirective, GlButton } from '../../../index';
 import { variantOptionsWithNoDefault } from '../../../utils/constants';
 import readme from './modal.md';
 

package/src/components/base/nav/nav.documentation.js

@@ -1,9 +1,5 @@
-import examples from './examples';
 import * as description from './nav.md';
 
 export default {
   description,
-  examples,
-  bootstrapComponent: 'b-nav',
-  propsInfo: {},
 };

package/src/components/base/nav/nav.md

@@ -1,8 +1,11 @@
-# Nav
+The navigation component is built with flexbox and provides a strong foundation for building all
+types of navigation components.
 
-<!-- STORY -->
+## `GlNavItem`
 
-## Usage
+Use `GlNavItem` to add actionable links (or router links) to your nav. `GlNavItem` wraps [`BNavItem`](https://bootstrap-vue.org/docs/components/navbar#b-nav-item).
 
-The navigation component is built with flexbox and provides a strong foundation for building all
-types of navigation components.
+## `GlNavItemDropdown`
+
+Use `GlNavItemDropdown` to place dropdown items within your nav.
+`GlNavItemDropdown` wraps [`BNavItemDropdown`](https://bootstrap-vue.org/docs/components/navbar#b-nav-item-dropdown).

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

@@ -1,23 +1,60 @@
-import { withKnobs } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
-import { GlNav, GlNavItem } from '../../../../index';
-import readme from './nav.md';
-
-const components = {
+import {
   GlNav,
   GlNavItem,
-};
+  GlNavItemDropdown,
+  GlDropdownItem,
+  GlDropdownDivider,
+  GlIcon,
+} from '../../../index';
+import readme from './nav.md';
 
-documentedStoriesOf('base/nav', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    template: `
+export const Default = (_args, { argTypes }) => ({
+  props: Object.keys(argTypes),
+  components: {
+    GlNav,
+    GlNavItem,
+    GlNavItemDropdown,
+    GlDropdownItem,
+    GlDropdownDivider,
+    GlIcon,
+  },
+  template: `
+    <div style="height: 150px">
       <gl-nav>
         <gl-nav-item active>Active</gl-nav-item>
         <gl-nav-item>Link</gl-nav-item>
-        <gl-nav-item>Another Link</gl-nav-item>
+        <gl-nav-item-dropdown text="Dropdown">
+          <gl-dropdown-item>Above divider</gl-dropdown-item>
+          <gl-dropdown-divider />
+          <gl-dropdown-item>Below divider</gl-dropdown-item>
+        </gl-nav-item-dropdown>
+        <gl-nav-item-dropdown text="Dropdown">
+          <template #button-content>
+            <gl-icon name="question" />
+            <gl-icon name="angle-down" />
+          </template>
+          <gl-dropdown-item>One</gl-dropdown-item>
+          <gl-dropdown-item>Two</gl-dropdown-item>
+        </gl-nav-item-dropdown>
         <gl-nav-item disabled>Disabled</gl-nav-item>
       </gl-nav>
-    `,
-  }));
+    </div>`,
+});
+
+export default {
+  title: 'base/nav',
+  component: GlNav,
+  subcomponents: {
+    GlNavItem,
+    GlNavItemDropdown,
+  },
+  parameters: {
+    bootstrapComponent: 'b-nav',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+};

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

@@ -1,4 +1,4 @@
-import { GlNavbar } from '../../../../index';
+import { GlNavbar } from '../../../index';
 import readme from './navbar.md';
 
 const Template = (args, { argTypes }) => ({

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

@@ -1,4 +1,4 @@
-import { GlPaginatedList, GlButton } from '../../../../index';
+import { GlPaginatedList, GlButton } from '../../../index';
 import readme from './paginated_list.md';
 
 const sampleList = [

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

@@ -1,4 +1,4 @@
-import { GlPath, GlPopover } from '../../../../index';
+import { GlPath, GlPopover } from '../../../index';
 import { glThemes } from '../../../utils/constants';
 import { mockPathItems } from './data';
 import readme from './path.md';

package/src/components/base/popover/popover.documentation.js

@@ -1,28 +1,3 @@
-import examples from './examples';
-
 export default {
   followsDesignSystem: true,
-  examples,
-  bootstrapComponent: 'b-popover',
-  bootstrapPropsInfo: {
-    target: {
-      additionalInfo:
-        'Element string ID, or a reference to an element or component, that you want to trigger the popover.',
-      required: true,
-    },
-    triggers: {
-      enum: 'triggerVariantOptions',
-    },
-    placement: {
-      enum: 'popoverPlacements',
-    },
-    boundary: {
-      additionalInfo:
-        '"scrollParent", "viewport", "window", or a reference to an HTML element. This is the container that the popover will be constrained to visually.You may need to change this if your target element is in a small container with overflow scroll',
-    },
-    container: {
-      additionalInfo:
-        'Specify container as null (default, appends to <body>) to avoid rendering problems in more complex components (like input groups, button groups, etc). You can use container to optionally specify a different element to append the popover to.',
-    },
-  },
 };

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

@@ -1,8 +1,8 @@
-import { withKnobs, select, text } from '@storybook/addon-knobs';
-import { GlPopover, GlButton } from '../../../../index';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
+import { GlPopover, GlButton } from '../../../index';
 import { popoverPlacements } from '../../../utils/constants';
 
+const defaultValue = (prop) => GlPopover.props[prop].default;
+
 const components = { GlPopover, GlButton };
 
 const contentString = `
@@ -11,84 +11,88 @@ const contentString = `
   massa ac, porta condimentum libero. Ut id lacus tristique, egestas arcu non, molestie nisi.
 `;
 
-const template = `
-  <div class="gl-display-flex gl-justify-content-center gl-p-6">
-    <gl-button id="pop-top">{{placement}}</gl-button>
-    <gl-popover target="pop-top"
-      triggers="hover focus"
+const getTemplate = (id, slots = '') => `
+  <div style="height:400px;" class="gl-display-flex gl-justify-content-center gl-align-items-center">
+    <gl-button id="${id}">{{placement}}</gl-button>
+    <gl-popover
+      target="${id}"
+      :triggers="triggers"
       :title="title"
       :placement="placement"
+      :show-close-button="showCloseButton"
       content="${contentString}"
-      data-testid="popover-with-props"
-      show
-      />
-  </div>
-  `;
+      data-testid="${id}"
+      :show="$options.viewMode !== 'docs'">${slots}</gl-popover>
+  </div>`;
 
-const scopedSlotTemplate = `
-  <div class="gl-display-flex gl-justify-content-center gl-p-6">
-    <gl-button id="pop-top-two" data-testid="popover-button-click">{{placement}}</gl-button>
-    <gl-popover target="pop-top-two"
-      triggers="click"
-      :placement="placement"
-      content="${contentString}"
-    >
-      <template #title>
-        <span data-testid="popover-title">Popover title</span>
-      </template>
-    </gl-popover>
-  </div>
-`;
+const generateProps = ({
+  placement = popoverPlacements.top,
+  title = 'Popover',
+  triggers = defaultValue('triggers'),
+  cssClasses = defaultValue('cssClasses'),
+  showCloseButton = defaultValue('showCloseButton'),
+} = {}) => ({
+  placement,
+  title,
+  triggers,
+  cssClasses,
+  showCloseButton,
+});
+
+export const Default = (_args, { viewMode, argTypes }) => ({
+  viewMode,
+  components,
+  props: Object.keys(argTypes),
+  template: getTemplate('popover-with-props'),
+});
+Default.args = generateProps();
 
-function generateProps({ placement = popoverPlacements.top, title = 'Popover', triggers } = {}) {
-  return {
+export const WithCloseButton = (_args, { viewMode, argTypes }) => ({
+  viewMode,
+  components,
+  props: Object.keys(argTypes),
+  template: getTemplate('popover-with-close-button'),
+});
+WithCloseButton.args = generateProps({
+  showCloseButton: true,
+});
+
+export const OnClick = (_args, { viewMode, argTypes }) => ({
+  viewMode,
+  components,
+  props: Object.keys(argTypes),
+  template: getTemplate(
+    'popover-button-click',
+    `
+    <template #title>
+      <span data-testid="popover-title">Popover title</span>
+    </template>
+  `
+  ),
+});
+OnClick.args = generateProps({
+  triggers: 'click',
+});
+OnClick.parameters = {
+  storyshots: { disable: true },
+};
+
+export default {
+  title: 'base/popover',
+  component: GlPopover,
+  parameters: {
+    knobs: { disable: true },
+    bootstrapComponent: 'b-popover',
+  },
+  argTypes: {
     placement: {
-      type: String,
-      default: select('placement', popoverPlacements, placement),
+      options: Object.values(popoverPlacements),
+      control: {
+        type: 'select',
+      },
     },
     title: {
-      type: String,
-      default: text('title', title),
+      control: { type: 'text' },
     },
-    triggers: {
-      type: String,
-      default: text('hover focus', triggers),
-    },
-  };
-}
-
-documentedStoriesOf('base/popover', '')
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    template,
-    props: generateProps(),
-  }))
-  .add('with close button', () => ({
-    components,
-    template: `
-      <div class="gl-display-flex gl-justify-content-center gl-p-6">
-        <gl-button id="pop-with-close-button">{{placement}}</gl-button>
-        <gl-popover
-          target="pop-with-close-button"
-          data-testid="popover-with-close-button"
-          triggers="hover focus"
-          :title="title"
-          :placement="placement"
-          content="${contentString}"
-          show
-          show-close-button
-          />
-      </div>
-    `,
-    props: generateProps(),
-  }))
-  .add(
-    'on click',
-    () => ({
-      components,
-      template: scopedSlotTemplate,
-      props: generateProps(),
-    }),
-    { storyshots: false }
-  );
+  },
+};

package/src/components/base/popover/popover.vue

@@ -18,6 +18,11 @@ export default {
       required: false,
       default: () => [],
     },
+    /**
+     * Space-separated triggers for the popover.
+     *
+     * @values click, hover, focus, manual
+     */
     triggers: {
       type: String,
       required: false,
@@ -45,6 +50,9 @@ export default {
   methods: {
     close(e) {
       this.$refs[popoverRefName].doClose();
+      /**
+       * Emitted when the close button is clicked (requires showCloseButton to be `true`).
+       */
       this.$emit('close-button-clicked', e);
     },
   },

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

@@ -1,4 +1,4 @@
-import { GlProgressBar } from '../../../../index';
+import { GlProgressBar } from '../../../index';
 import { variantOptions } from '../../../utils/constants';
 
 const generateProps = ({ value = 30, variant = variantOptions.primary } = {}) => ({

package/src/components/base/search_box_by_click/search_box_by_click.documentation.js

@@ -52,6 +52,9 @@ export default {
       additionalInfo:
         'Container for tooltip. Valid values: DOM node, selector string or `false` for default',
     },
+    searchButtonAttributes: {
+      additionalInfo: 'HTML attributes to add to the search button',
+    },
   },
   events: [
     {

package/src/components/base/search_box_by_click/search_box_by_click.spec.js

@@ -25,6 +25,7 @@ describe('search box by click component', () => {
   };
 
   const findClearIcon = () => wrapper.findComponent(ClearIcon);
+  const findSearchButton = () => wrapper.find('[data-testid="search-button"]');
 
   it('emits input event when input changes', async () => {
     createComponent({ value: 'somevalue' });
@@ -125,8 +126,8 @@ describe('search box by click component', () => {
     });
 
     it('displays disabled search button', () => {
-      expect(wrapper.findComponent({ ref: 'searchButton' }).exists()).toBe(true);
-      expect(wrapper.findComponent({ ref: 'searchButton' }).attributes('disabled')).toBe('true');
+      expect(findSearchButton().exists()).toBe(true);
+      expect(findSearchButton().attributes('disabled')).toBe('true');
     });
 
     it('does not render clear icon even with value', () => {
@@ -145,9 +146,19 @@ describe('search box by click component', () => {
 
   it('emits submit event when search button is pressed', async () => {
     createComponent({ value: 'some-input' });
-    wrapper.findComponent({ ref: 'searchButton' }).vm.$emit('click');
+    findSearchButton().vm.$emit('click');
 
     await wrapper.vm.$nextTick();
     expect(wrapper.emitted().submit[0]).toEqual(['some-input']);
   });
+
+  it('adds `searchButtonAttributes` prop to search button', () => {
+    const searchButtonAttributes = { 'data-qa-selector': 'foo-bar' };
+
+    createComponent({ searchButtonAttributes });
+
+    expect(findSearchButton().attributes('data-qa-selector')).toBe(
+      searchButtonAttributes['data-qa-selector']
+    );
+  });
 });

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

@@ -1,6 +1,6 @@
 import { withKnobs, boolean, text } from '@storybook/addon-knobs';
 import { documentedStoriesOf } from '../../../../documentation/documented_stories';
-import { GlSearchBoxByClick } from '../../../../index';
+import { GlSearchBoxByClick } from '../../../index';
 import readme from './search_box_by_click.md';
 
 const components = {

package/src/components/base/search_box_by_click/search_box_by_click.vue

@@ -84,6 +84,11 @@ export default {
       validator: (value) =>
         value === false || typeof value === 'string' || value instanceof HTMLElement,
     },
+    searchButtonAttributes: {
+      type: Object,
+      required: false,
+      default: () => ({}),
+    },
   },
   data() {
     return {
@@ -216,11 +221,13 @@ export default {
     />
     <template #append class="gl-search-box-by-click-input-group-control">
       <gl-button
+        v-bind="searchButtonAttributes"
         ref="searchButton"
         class="gl-search-box-by-click-search-button"
         icon="search"
         :disabled="disabled"
         aria-label="Search"
+        data-testid="search-button"
         @click="search(currentValue)"
       />
     </template>

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

@@ -1,6 +1,6 @@
 import { withKnobs, boolean, text } from '@storybook/addon-knobs';
 import { documentedStoriesOf } from '../../../../documentation/documented_stories';
-import { GlSearchBoxByType } from '../../../../index';
+import { GlSearchBoxByType } from '../../../index';
 import readme from './search_box_by_type.md';
 
 const components = {