@gitlab/ui 36.7.1 → 37.2.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,9 @@ export const setupStorybookReadme = () =>
         'GlHeatmap',
         'GlFormRadioGroup',
         'GlChartSeriesLabel',
+        'GlAreaChart',
+        'GlLineChart',
+        'GlFormInputGroup',
       ],
       components: {
         GlComponentDocumentation,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "36.7.1",
+  "version": "37.2.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -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/form/form_input_group/form_input_group.documentation.js

@@ -1,34 +1,6 @@
-import examples from './examples';
 import description from './form_input_group.md';
 
 export default {
   followsDesignSystem: false,
   description,
-  examples,
-  bootstrapComponent: 'b-form-input',
-  propsInfo: {
-    'select-on-click': {
-      type: Boolean,
-      additionalInfo: 'Automatically selects the content of the input field on click',
-    },
-    'predefined-options': {
-      type: Array,
-      additionalInfo:
-        'Array of options. Each option should have `name` and `value` information: {name: "Foo", value: "Bar"})',
-    },
-  },
-  slots: [
-    {
-      name: 'default',
-      description: 'Allows replacement of default input field.',
-    },
-    {
-      name: 'prepend',
-      description: 'Is rendered in front of the input field.',
-    },
-    {
-      name: 'append',
-      description: 'Is rendered after the input field.',
-    },
-  ],
 };

package/src/components/base/form/form_input_group/form_input_group.md

@@ -1,7 +1,3 @@
-# Form Group Input
-
-<!-- STORY -->
-
 The `GlFormInputGroup` component allows one to build more advanced text
 input fields than generic `GlFormInput` when one needs that flexibility.
 Basic usage of the component:

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

@@ -1,73 +1,95 @@
-import { withKnobs, boolean, object, text } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../../documentation/documented_stories';
 import { GlFormInputGroup, GlInputGroupText } from '../../../../index';
+import { disableControls } from '../../../../utils/stories_utils';
 import readme from './form_input_group.md';
 
-const components = {
-  GlFormInputGroup,
-  GlInputGroupText,
-};
-const predefinedOptions = [
-  { name: 'Embed', value: 'https://embed.com' },
-  { name: 'Share', value: 'https://share.org' },
-];
+const template = `
+  <gl-form-input-group
+    :readonly="readonly"
+    :select-on-click="selectOnClick"
+    :predefined-options="predefinedOptions"
+    :label="label"
+    :inputClass="inputClass">
+    <template #prepend v-if="prepend">
+      <gl-input-group-text>{{prepend}}</gl-input-group-text>
+    </template>
+    <template #append v-if="append">
+      <gl-input-group-text>{{append}}</gl-input-group-text>
+    </template>
+  </gl-form-input-group>
+`;
 
-documentedStoriesOf('base/form/form-input-group', readme)
-  .addDecorator(withKnobs)
-  .add('default', () => ({
-    components,
-    props: {
-      prepend: {
-        default: text('Prepend text', 'Username'),
-      },
-      append: {
-        default: text('Append text', 'Add'),
-      },
-      readonly: {
-        default: boolean('Readonly', false),
-      },
-      select: {
-        default: boolean('Select text on click', false),
+const defaultValue = (prop) => GlFormInputGroup.props[prop].default;
+
+const generateProps = ({
+  prepend = 'Username',
+  append = 'Add',
+  readonly = false,
+  selectOnClick = false,
+  predefinedOptions = defaultValue('predefinedOptions')(),
+  label = '',
+  inputClass = '',
+} = {}) => ({
+  prepend,
+  append,
+  readonly,
+  selectOnClick,
+  predefinedOptions,
+  label,
+  inputClass,
+});
+
+const Template = (args, { argTypes }) => ({
+  components: { GlFormInputGroup, GlInputGroupText },
+  props: Object.keys(argTypes),
+  template,
+});
+
+export const Default = Template.bind({});
+Default.args = generateProps();
+
+export const PredefinedOptions = Template.bind({});
+PredefinedOptions.args = generateProps({
+  prepend: '',
+  predefinedOptions: [
+    { name: 'Embed', value: 'https://embed.com' },
+    { name: 'Share', value: 'https://share.org' },
+  ],
+});
+
+export default {
+  title: 'base/form/form-input-group',
+  component: GlFormInputGroup,
+  knobs: { disabled: true },
+  parameters: {
+    bootstrapComponent: 'b-form-input',
+    docs: {
+      description: {
+        component: readme,
       },
     },
-    template: `
-      <gl-form-input-group :readonly="readonly" :select-on-click="select">
-        <template #prepend v-if="prepend">
-          <gl-input-group-text>{{prepend}}</gl-input-group-text>
-        </template>
-        <template #append v-if="append">
-          <gl-input-group-text>{{append}}</gl-input-group-text>
-        </template>
-      </gl-form-input-group>
-    `,
-  }))
-  .add('with predefined options', () => ({
-    components,
-    props: {
-      prepend: {
-        default: text('Prepend text', ''),
+    knobs: { disabled: true },
+  },
+  argTypes: {
+    ...disableControls(['value']),
+    prepend: {
+      control: {
+        type: 'text',
       },
-      append: {
-        default: text('Append text', 'Add'),
-      },
-      readonly: {
-        default: boolean('Readonly', false),
+    },
+    append: {
+      control: {
+        type: 'text',
       },
-      select: {
-        default: boolean('Select text on click', false),
+    },
+    inputClass: {
+      control: {
+        type: 'text',
       },
-      options: {
-        default: object('Predefined options', predefinedOptions),
+    },
+    label: {
+      control: {
+        type: 'text',
       },
     },
-    template: `
-      <gl-form-input-group :readonly="readonly" :select-on-click="select" :predefined-options="options">
-        <template #prepend v-if="prepend">
-          <gl-input-group-text>{{prepend}}</gl-input-group-text>
-        </template>
-        <template #append v-if="append">
-          <gl-input-group-text>{{append}}</gl-input-group-text>
-        </template>
-      </gl-form-input-group>
-    `,
-  }));
+  },
+};

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

@@ -16,11 +16,17 @@ export default {
   },
   mixins: [InputGroupMixin],
   props: {
+    /**
+     * Automatically selects the content of the input field on click.
+     */
     selectOnClick: {
       type: Boolean,
       required: false,
       default: false,
     },
+    /**
+     * Array of options. Each option should have `name` and `value` information: {name: "Foo", value: "Bar"})
+     */
     predefinedOptions: {
       type: Array,
       required: false,
@@ -61,6 +67,7 @@ export default {
   <div>
     <b-input-group>
       <b-input-group-prepend v-if="activeOption || $scopedSlots.prepend">
+        <!-- @slot Is rendered in front of the input field. -->
         <slot name="prepend"></slot>
         <gl-dropdown v-if="activeOption" :text="activeOption">
           <gl-dropdown-item
@@ -74,6 +81,7 @@ export default {
           </gl-dropdown-item>
         </gl-dropdown>
       </b-input-group-prepend>
+      <!-- @slot Allows replacement of default input field. -->
       <slot>
         <b-form-input
           ref="input"
@@ -86,6 +94,7 @@ export default {
         />
       </slot>
       <b-input-group-append v-if="$scopedSlots.append">
+        <!-- @slot Is rendered after the input field. -->
         <slot name="append"></slot>
       </b-input-group-append>
     </b-input-group>