@gitlab/ui 36.7.0 → 37.1.0

package/dist/utils/stories_utils.js

@@ -9,5 +9,17 @@ const SERIES_NAME = {
   [SERIES_NAME_LONG]: 'Series name long. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed tincidunt interdum sapien ut blandit. Nulla fermentum nisi id euismod vulputate. END',
   [SERIES_NAME_LONG_WITHOUT_SPACES]: 'Series_name_long._Lorem_ipsum_dolor_sit_amet,_consectetur_adipiscing_elit._Sed_tincidunt_interdum_sapien_ut_blandit._Nulla_fermentum_nisi_id_euismod_vulputate._END'
 };
+/**
+ * Builds the parameters object disable one or multiple controls.
+ */
+
+const disableControls = function () {
+  let controls = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  return Object.fromEntries(controls.map(control => [control, {
+    control: {
+      disable: true
+    }
+  }]));
+};
 
-export { SERIES_NAME, SERIES_NAME_LONG, SERIES_NAME_LONG_WITHOUT_SPACES, SERIES_NAME_SHORT };
+export { SERIES_NAME, SERIES_NAME_LONG, SERIES_NAME_LONG_WITHOUT_SPACES, SERIES_NAME_SHORT, disableControls };

package/documentation/components_documentation.js

@@ -16,7 +16,6 @@ export { default as GlNavbarDocumentation } from '../src/components/base/navbar/
 export { default as GlIntersectionObserverDocumentation } from '../src/components/utilities/intersection_observer/intersection_observer.documentation';
 export { default as GlChartDocumentation } from '../src/components/charts/chart/chart.documentation';
 export { default as GlAreaChartDocumentation } from '../src/components/charts/area/area.documentation';
-export { default as GlChartLegendDocumentation } from '../src/components/charts/legend/legend.documentation';
 export { default as GlLineChartDocumentation } from '../src/components/charts/line/line.documentation';
 export { default as GlSparklineChartDocumentation } from '../src/components/charts/sparkline/sparkline.documentation';
 export { default as GlChartSeriesLabelDocumentation } from '../src/components/charts/series_label/series_label.documentation';
@@ -64,7 +63,6 @@ export { default as GlTableDocumentation } from '../src/components/base/table/ta
 export { default as GlBreadcrumbDocumentation } from '../src/components/base/breadcrumb/breadcrumb.documentation';
 export { default as GlHeatmapDocumentation } from '../src/components/charts/heatmap/heatmap.documentation';
 export { default as GlTabsDocumentation } from '../src/components/base/tabs/tabs/tabs.documentation';
-export { default as GlTabDocumentation } from '../src/components/base/tabs/tab/tab.documentation';
 export { default as GlButtonGroupDocumentation } from '../src/components/base/button_group/button_group.documentation';
 export { default as GlFormCheckboxDocumentation } from '../src/components/base/form/form_checkbox/form_checkbox.documentation';
 export { default as GlLabelDocumentation } from '../src/components/base/label/label.documentation';

package/documentation/documented_stories.js

@@ -102,6 +102,7 @@ export const setupStorybookReadme = () =>
         'GlFormInput',
         'GlSegmentedControl',
         'GlAvatar',
+        'GlChartLegend',
         'GlAvatarLink',
         'GlPagination',
         'GlSkeletonLoader',
@@ -117,6 +118,8 @@ export const setupStorybookReadme = () =>
         'GlKeysetPagination',
         'GlForm',
         'GlTable',
+        'GlTab',
+        'GlTabs',
         'GlToast',
         'GlPaginatedList',
         'GlIntersectionObserver',
@@ -132,6 +135,8 @@ export const setupStorybookReadme = () =>
         'GlHeatmap',
         'GlFormRadioGroup',
         'GlChartSeriesLabel',
+        'GlAreaChart',
+        'GlLineChart',
       ],
       components: {
         GlComponentDocumentation,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "36.7.0",
+  "version": "37.1.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -58,7 +58,7 @@
     "@babel/standalone": "^7.0.0",
     "bootstrap-vue": "2.20.1",
     "copy-to-clipboard": "^3.0.8",
-    "dompurify": "^2.3.5",
+    "dompurify": "^2.3.6",
     "echarts": "^5.2.1",
     "highlight.js": "^10.6.0",
     "iframe-resizer": "^4.3.2",
@@ -85,7 +85,7 @@
     "@babel/preset-env": "^7.10.2",
     "@gitlab/eslint-plugin": "10.0.2",
     "@gitlab/stylelint-config": "4.0.0",
-    "@gitlab/svgs": "2.5.0",
+    "@gitlab/svgs": "2.6.0",
     "@rollup/plugin-commonjs": "^11.1.0",
     "@rollup/plugin-node-resolve": "^7.1.3",
     "@rollup/plugin-replace": "^2.3.2",

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

@@ -1,3 +1,4 @@
+import { disableControls } from '../../../utils/stories_utils';
 import readme from './accordion.md';
 import GlAccordion from './accordion.vue';
 import GlAccordionItem from './accordion_item.vue';
@@ -63,6 +64,6 @@ export default {
         options: [1, 2, 3, 4, 5, 6],
       },
     },
-    autoCollapse: { control: { disable: true } },
+    ...disableControls(['autoCollapse']),
   },
 };

package/src/components/base/alert/alert.scss

@@ -85,44 +85,6 @@
   @include gl-right-4;
 }
 
-.gl-alert-max-content {
-  @include gl-display-flex;
-  @include gl-justify-content-center;
-  @include gl-p-5;
-
-  .gl-alert-icon {
-    @include gl-static;
-    @include gl-mr-5;
-    @include gl-flex-shrink-0;
-  }
-
-  .gl-dismiss-btn {
-    @include gl-static;
-    @include gl-align-self-start;
-    @include gl-ml-4;
-    // The negative margins optically align the × with the title text and right padding
-    margin-top: -$gl-spacing-scale-2;
-    margin-right: -$gl-spacing-scale-2;
-    order: 3;
-  }
-
-  .gl-alert-container {
-    @include gl-relative;
-    @include gl-display-flex;
-    @include gl-justify-content-space-between;
-    @include gl-flex-grow-1;
-    @include gl-mx-auto;
-  }
-
-  .gl-alert-content {
-    @include gl-flex-grow-1;
-  }
-}
-
-.gl-alert-layout-limited .gl-alert-container {
-  @include gl-layout-w-limited;
-}
-
 .gl-alert-danger {
   @include gl-bg-red-50;
 

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

@@ -154,7 +154,6 @@ describe('Alert component', () => {
   describe('top-level classes', () => {
     describe.each`
       prop             | cssClass                      | presentIf
-      ${'contained'}   | ${'gl-alert-max-content'}     | ${true}
       ${'sticky'}      | ${'gl-alert-sticky'}          | ${true}
       ${'dismissible'} | ${'gl-alert-not-dismissible'} | ${false}
     `('$cssClass', ({ prop, cssClass, presentIf }) => {

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

@@ -12,7 +12,6 @@ const template = `
     :secondary-button-text="secondaryButtonText"
     :primary-button-link="primaryButtonLink"
     :secondary-button-link="secondaryButtonLink"
-    :contained="contained"
     :sticky="sticky"
   >{{ message }}</gl-alert>`;
 
@@ -27,7 +26,6 @@ const generateProps = ({
   primaryButtonLink = defaultValue('primaryButtonLink'),
   secondaryButtonText = defaultValue('secondaryButtonText'),
   secondaryButtonLink = defaultValue('secondaryButtonLink'),
-  contained = defaultValue('contained'),
   sticky = defaultValue('sticky'),
 } = {}) => ({
   title,
@@ -39,7 +37,6 @@ const generateProps = ({
   primaryButtonLink,
   secondaryButtonText,
   secondaryButtonLink,
-  contained,
   sticky,
 });
 
@@ -118,11 +115,6 @@ Variants.parameters = {
   storyshots: { disable: true },
 };
 
-export const Contained = Template.bind({});
-Contained.args = generateProps({
-  contained: true,
-});
-
 export const Sticky = () => ({
   components: { GlAlert },
   variants: alertVariantOptions,

package/src/components/base/alert/alert.vue

@@ -74,14 +74,6 @@ export default {
       required: false,
       default: '',
     },
-    /**
-     * Contained alerts have their content's width limited.
-     */
-    contained: {
-      type: Boolean,
-      required: false,
-      default: false,
-    },
     sticky: {
       type: Boolean,
       required: false,
@@ -171,48 +163,45 @@ export default {
   <div
     :class="[
       'gl-alert',
-      { 'gl-alert-max-content gl-alert-layout-limited': contained },
       { 'gl-alert-sticky': sticky },
       { 'gl-alert-not-dismissible': !dismissible },
       variantClass,
     ]"
   >
-    <div class="gl-alert-container">
-      <gl-icon
-        :name="iconName"
-        :class="{ 'gl-alert-icon': true, 'gl-alert-icon-no-title': !title }"
-      />
+    <gl-icon
+      :name="iconName"
+      :class="{ 'gl-alert-icon': true, 'gl-alert-icon-no-title': !title }"
+    />
 
-      <close-button
-        v-if="dismissible"
-        ref="dismiss"
-        class="gl-dismiss-btn"
-        :label="dismissLabel"
-        @click="onDismiss"
-      />
+    <close-button
+      v-if="dismissible"
+      ref="dismiss"
+      class="gl-dismiss-btn"
+      :label="dismissLabel"
+      @click="onDismiss"
+    />
 
-      <div class="gl-alert-content" role="alert">
-        <h4 v-if="title" class="gl-alert-title">{{ title }}</h4>
+    <div class="gl-alert-content" role="alert">
+      <h4 v-if="title" class="gl-alert-title">{{ title }}</h4>
 
-        <div class="gl-alert-body">
-          <!-- @slot The alert message to display. -->
-          <slot></slot>
-        </div>
+      <div class="gl-alert-body">
+        <!-- @slot The alert message to display. -->
+        <slot></slot>
+      </div>
 
-        <div v-if="shouldRenderActions" class="gl-alert-actions">
-          <!-- @slot If the primary/secondary action buttons aren't flexible enough, place arbitrary content here. -->
-          <slot name="actions">
-            <gl-button
-              v-for="(actionButton, index) in actionButtons"
-              :key="index"
-              class="gl-alert-action"
-              v-bind="actionButton.attrs"
-              v-on="actionButton.listeners"
-            >
-              {{ actionButton.text }}
-            </gl-button>
-          </slot>
-        </div>
+      <div v-if="shouldRenderActions" class="gl-alert-actions">
+        <!-- @slot If the primary/secondary action buttons aren't flexible enough, place arbitrary content here. -->
+        <slot name="actions">
+          <gl-button
+            v-for="(actionButton, index) in actionButtons"
+            :key="index"
+            class="gl-alert-action"
+            v-bind="actionButton.attrs"
+            v-on="actionButton.listeners"
+          >
+            {{ actionButton.text }}
+          </gl-button>
+        </slot>
       </div>
     </div>
   </div>

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

@@ -1,6 +1,7 @@
 import iconSpriteInfo from '@gitlab/svgs/dist/icons.json';
 import { GlBadge } from '../../../index';
 import { badgeSizeOptions, badgeVariantOptions } from '../../../utils/constants';
+import { disableControls } from '../../../utils/stories_utils';
 import readme from './badge.md';
 
 const template = `
@@ -61,14 +62,7 @@ export const Variants = (args, { argTypes }) => ({
 Variants.args = generateProps({
   variant: badgeVariantOptions.warning,
 });
-Variants.argTypes = {
-  content: {
-    control: { disable: true },
-  },
-  variant: {
-    control: { disable: true },
-  },
-};
+Variants.argTypes = disableControls(['content', 'variant']);
 
 export const Actionable = (args, { argTypes }) => ({
   components: { GlBadge },
@@ -95,14 +89,7 @@ Actionable.args = generateProps({
 Actionable.parameters = {
   storyshots: { disable: true },
 };
-Actionable.argTypes = {
-  content: {
-    control: { disable: true },
-  },
-  variant: {
-    control: { disable: true },
-  },
-};
+Actionable.argTypes = disableControls(['content', 'variant']);
 
 export const Sizes = (args, { argTypes }) => ({
   components: { GlBadge },
@@ -125,14 +112,7 @@ export const Sizes = (args, { argTypes }) => ({
 Sizes.args = generateProps({
   variant: badgeVariantOptions.danger,
 });
-Sizes.argTypes = {
-  content: {
-    control: { disable: true },
-  },
-  size: {
-    control: { disable: true },
-  },
-};
+Sizes.argTypes = disableControls(['content', 'size']);
 
 export const BadgeIcon = (args, { argTypes }) => ({
   components: { GlBadge },

package/src/components/base/card/card.vue

@@ -31,7 +31,7 @@ export default {
 
 <template>
   <div class="gl-card">
-    <div v-if="this.$slots.header" class="gl-card-header" :class="headerClass">
+    <div v-if="$slots.header" class="gl-card-header" :class="headerClass">
       <!-- @slot The card's header content. -->
       <slot name="header"></slot>
     </div>
@@ -39,7 +39,7 @@ export default {
       <!-- @slot The card's main content. -->
       <slot></slot>
     </div>
-    <div v-if="this.$slots.footer" class="gl-card-footer" :class="footerClass">
+    <div v-if="$slots.footer" class="gl-card-footer" :class="footerClass">
       <!-- @slot The card's footer content. -->
       <slot name="footer"></slot>
     </div>

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

@@ -1,3 +1,4 @@
+import { disableControls } from '../../../utils/stories_utils';
 import readme from './daterange_picker.md';
 import GlDaterangePicker from './daterange_picker.vue';
 
@@ -121,31 +122,15 @@ export default {
     },
   },
   argTypes: {
-    i18n: {
-      control: {
-        disable: true,
-      },
-    },
-    startPickerTarget: {
-      control: {
-        disable: true,
-      },
-    },
-    startPickerContainer: {
-      control: {
-        disable: true,
-      },
-    },
-    endPickerTarget: {
-      control: {
-        disable: true,
-      },
-    },
-    endPickerContainer: {
-      control: {
-        disable: true,
-      },
-    },
+    ...disableControls([
+      'i18n',
+      'startPickerTarget',
+      'startPickerContainer',
+      'endPickerTarget',
+      'endPickerContainer',
+      'defaultStartDate',
+      'defaultEndDate',
+    ]),
     defaultMinDate: {
       control: {
         type: 'date',
@@ -156,15 +141,5 @@ export default {
         type: 'date',
       },
     },
-    defaultStartDate: {
-      control: {
-        disable: true,
-      },
-    },
-    defaultEndDate: {
-      control: {
-        disable: true,
-      },
-    },
   },
 };

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

@@ -1,6 +1,6 @@
 import description from './drawer.md';
 
 export default {
-  followsDesignSystem: false,
+  followsDesignSystem: true,
   description,
 };

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

@@ -1,6 +1,7 @@
 import iconSpriteInfo from '@gitlab/svgs/dist/icons.json';
 import { GlIcon } from '../../../index';
 import { iconSizeOptions } from '../../../utils/constants';
+import { disableControls } from '../../../utils/stories_utils';
 import readme from './icon.md';
 
 const components = {
@@ -41,6 +42,7 @@ export default {
     storyshots: { disable: true },
   },
   argTypes: {
+    ...disableControls(['useDeprecatedSizes']),
     name: {
       control: {
         type: 'select',
@@ -53,10 +55,5 @@ export default {
         options: iconSizeOptions,
       },
     },
-    useDeprecatedSizes: {
-      control: {
-        disable: true,
-      },
-    },
   },
 };

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

@@ -179,6 +179,7 @@ describe('pagination component', () => {
     it('shows 3rd page as active and enables all buttons', () => {
       const buttons = findButtons();
       expect(buttons.at(3).classes()).toEqual(expectClassActive);
+      expect(buttons.at(3).attributes('aria-current')).toEqual('page');
       buttons.wrappers.forEach((button) => {
         expect(button.element.tagName).not.toBe('SPAN');
       });
@@ -222,6 +223,7 @@ describe('pagination component', () => {
       const buttons = findButtons();
       expect(buttons.at(0).element.tagName).toBe('SPAN');
       expect(buttons.at(1).classes()).toEqual(expectClassActive);
+      expect(buttons.at(1).attributes('aria-current')).toEqual('page');
       expect(buttons.at(buttons.length - 1).element.tagName).not.toBe('SPAN');
     });
 
@@ -310,6 +312,7 @@ describe('pagination component', () => {
       const buttons = findButtons();
       expect(buttons.at(0).element.tagName).not.toBe('SPAN');
       expect(buttons.at(7).classes()).toEqual(expectClassActive);
+      expect(buttons.at(7).attributes('aria-current')).toEqual('page');
       expect(buttons.at(buttons.length - 1).element.tagName).toBe('SPAN');
     });
 

package/src/components/base/pagination/pagination.vue

@@ -293,6 +293,7 @@ export default {
       const listeners = {};
       if (isActivePage) {
         attrs.class.push('active');
+        attrs['aria-current'] = 'page';
       }
       // Disable previous and/or next buttons if needed
       if (this.isLinkBased) {

package/src/components/base/path/__snapshots__/path.spec.js.snap

@@ -155,7 +155,9 @@ exports[`Path matches the snapshot 1`] = `
       id="path-1-item-7"
     >
       <button
+        category="tertiary"
         class="gl-path-button"
+        disabled="disabled"
       >
         <!---->
         
@@ -383,7 +385,9 @@ exports[`Path renders the list of items with icons matches the snapshot 1`] = `
       id="path-15-item-7"
     >
       <button
+        category="tertiary"
         class="gl-path-button"
+        disabled="disabled"
       >
         <!---->
         
@@ -606,7 +610,9 @@ exports[`Path renders the list of items with metrics matches the snapshot 1`] =
       id="path-11-item-7"
     >
       <button
+        category="tertiary"
         class="gl-path-button"
+        disabled="disabled"
       >
         <!---->
         

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

@@ -30,6 +30,7 @@ export const mockPathItems = [
   {
     title: 'Eighth',
     metric: '8d',
+    disabled: true,
   },
   {
     title: 'Ninth',

package/src/components/base/path/path.scss

@@ -78,7 +78,12 @@ $path-chevron-right-margin: px-to-rem(14px);
       @include gl-path-chevron;
     }
 
-    &:hover {
+    &[disabled] {
+      @include gl-text-gray-400;
+      @include gl-cursor-not-allowed;
+    }
+
+    &:not([disabled]):hover {
       @include gl-path-active-item-color($gray-100);
       @include gl-text-gray-900;
     }

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

@@ -188,6 +188,14 @@ describe('Path', () => {
         ]);
       });
     });
+
+    describe('when a disabled item is clicked', () => {
+      it('does not emit the selected event', () => {
+        clickItemAt(7);
+
+        expect(wrapper.emitted('selected')).toBeUndefined();
+      });
+    });
   });
 
   describe('slots', () => {

package/src/components/base/path/path.vue

@@ -21,9 +21,10 @@ export default {
      * A list of path items in the form:
      * ```
      * {
-     *   title:  String, required
-     *   metric: Any, optional
-     *   icon:   String, optional
+     *   title:    String, required
+     *   metric:   Any, optional
+     *   icon:     String, optional
+     *   disabled: Boolean, optional
      * }
      * ```
      */
@@ -164,7 +165,12 @@ export default {
         :key="index"
         class="gl-path-nav-list-item"
       >
-        <button :class="pathItemClass(index)" @click="onItemClicked(index)">
+        <button
+          :class="pathItemClass(index)"
+          :category="item.disabled ? 'tertiary' : undefined"
+          :disabled="item.disabled"
+          @click="onItemClicked(index)"
+        >
           <gl-icon
             v-if="shouldDisplayIcon(item.icon)"
             :name="item.icon"

package/src/components/base/tabs/tab/tab.vue

@@ -15,6 +15,9 @@ export default {
       required: false,
       default: '',
     },
+    /**
+     * Query string parameter value to use when `gl-tabs` `sync-active-tab-with-query-params` prop is set to `true`.
+     */
     queryParamValue: {
       type: String,
       required: false,
@@ -36,6 +39,7 @@ export default {
   },
 };
 </script>
+
 <template>
   <b-tab
     :title-link-class="linkClass"

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

@@ -1,18 +1,6 @@
-import examples from './examples';
 import description from './tabs.md';
 
 export default {
   description,
-  examples,
-  bootstrapComponent: 'b-tabs',
   followsDesignSystem: true,
-  propsInfo: {
-    syncActiveTabWithQueryParams: {
-      additionalInfo:
-        'Sync active tab with query string parameters. Allows for deep linking into specific tabs.',
-    },
-    queryParamName: {
-      additionalInfo: 'Name to use for query string parameter.',
-    },
-  },
 };

package/src/components/base/tabs/tabs/tabs.md

@@ -1,15 +1,10 @@
-# Tabs
-
-<!-- STORY -->
-## Usage
-
 Tabs are used to divide content into meaningful, related sections. Tabs allow users to focus on one
 specific view at a time while maintaining sight of all the relevant content options available. Each
 tab, when active, will reveal it’s own unique content.
 
 ## Using the component Vue
 
-~~~js
+~~~html
 <gl-tabs>
   <gl-tab title="Tab 1">
     Tab panel 1
@@ -22,7 +17,7 @@ tab, when active, will reveal it’s own unique content.
 
 ## Using the component HTML
 
-~~~js
+~~~html
 <div class="tabs gl-tabs">
   <ul role="tablist" class="nav gl-tabs-nav">
     <li role="presentation" class="nav-item">