@gitlab/ui 32.41.0 → 32.42.0

package/src/components/base/tooltip/tooltip.md

@@ -1,8 +1,6 @@
-## Usage
-
 Using the tooltip component is recommended if you have HTML content.
 It is also currently required if the tooltip content needs to change while it's visible
-(see [this upstream issue]). In all other cases, please use the directive.
+(see [this upstream issue][this upstream issue]). In all other cases, please use the directive.
 
 [this upstream issue]: https://github.com/bootstrap-vue/bootstrap-vue/issues/2142
 
@@ -43,11 +41,11 @@ export default {
 
 ## Directive attributes
 
-`v-gl-tooltip` directive uses the same attributes as [`v-b-tooltip`].
+`v-gl-tooltip` directive uses the same attributes as [`v-b-tooltip`][`v-b-tooltip`].
 
 ## Under the hood
 
-Tooltip uses [`<b-tooltip>`] and [`v-b-tooltip`] internally.
+Tooltip uses [`<b-tooltip>`][`<b-tooltip>`] and [`v-b-tooltip`][`v-b-tooltip`] internally.
 
 [`<b-tooltip>`]: https://bootstrap-vue.org/docs/components/tooltip
 

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

@@ -19,11 +19,6 @@ describe('GlTooltip', () => {
     createWrapper();
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-    wrapper = null;
-  });
-
   it.each(tooltipActionEvents)('passes through the %s event to the bvTooltip instance', (event) => {
     wrapper.vm.$emit(event);
 

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

@@ -1,34 +1,58 @@
-import { withKnobs } from '@storybook/addon-knobs';
-import { documentedStoriesOf } from '../../../../documentation/documented_stories';
-import { GlTooltipDirective } from '../../../../index';
+import { GlTooltip, GlTooltipDirective } from '../../../../index';
 import readme from './tooltip.md';
 
-const directives = {
-  GlTooltip: GlTooltipDirective,
-};
-
 function makeTooltip(modifier = '') {
-  return () => ({
-    directives,
+  return {
+    directives: {
+      GlTooltip: GlTooltipDirective,
+    },
     template: `
-      <div class="d-flex align-items-center justify-content-center p-5 m-5">
-        <gl-button
-          v-gl-tooltip${modifier}
-          title="some tooltip text"
-        >
-            Tooltip
-        </gl-button>
-      </div>
-    `,
+    <div class="gl-display-flex gl-align-items-center gl-justify-content-center gl-p-7 gl-m-7">
+      <gl-button
+        v-gl-tooltip${modifier}
+        title="some tooltip text"
+      >
+          Tooltip
+      </gl-button>
+    </div>
+  `,
     mounted() {
       this.$nextTick(() => this.$el.querySelector('button').focus());
     },
-  });
+  };
 }
 
-documentedStoriesOf('base/tooltip', readme)
-  .addDecorator(withKnobs)
-  .add('top (default)', makeTooltip())
-  .add('right', makeTooltip('.right'))
-  .add('bottom', makeTooltip('.bottom'))
-  .add('left', makeTooltip('.left'));
+export const TopDefault = (args, argTypes) => ({
+  ...makeTooltip(),
+  props: Object.keys(argTypes),
+});
+
+export const Right = (args, argTypes) => ({
+  ...makeTooltip('.right'),
+  props: Object.keys(argTypes),
+});
+
+export const Bottom = (args, argTypes) => ({
+  ...makeTooltip('.bottom'),
+  props: Object.keys(argTypes),
+});
+
+export const Left = (args, argTypes) => ({
+  ...makeTooltip('.left'),
+  props: Object.keys(argTypes),
+});
+
+// A default export contains higher-level info about the component and the stories' settings.
+export default {
+  title: 'base/tooltip',
+  component: GlTooltip,
+  parameters: {
+    bootstrapComponent: 'b-tooltip',
+    knobs: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+};

package/src/components/base/tooltip/tooltip.vue

@@ -23,6 +23,7 @@ export default {
     :delay="$options.tooltipDelay"
     v-on="$listeners"
   >
+    <!-- @slot Tooltip content -->
     <slot></slot>
   </b-tooltip>
 </template>

package/src/components/charts/area/area.spec.js

@@ -5,6 +5,7 @@ import ChartLegend from '../legend/legend.vue';
 import AreaChart from './area.vue';
 
 import { LEGEND_LAYOUT_INLINE, LEGEND_LAYOUT_TABLE } from '~/utils/charts/constants';
+import { createMockChartInstance, ChartTooltipStub } from '~helpers/chart_stubs';
 
 let mockChartInstance;
 
@@ -14,7 +15,6 @@ jest.mock('echarts', () => ({
 
 describe('area component', () => {
   let wrapper;
-  let option;
 
   const findChart = () => wrapper.findComponent(Chart);
   const findLegend = () => wrapper.findComponent(ChartLegend);
@@ -24,33 +24,17 @@ describe('area component', () => {
   const emitChartCreated = () => findChart().vm.$emit('created', mockChartInstance);
 
   const createShallowWrapper = (props = {}) => {
-    wrapper = shallowMount(AreaChart, { propsData: { option, data: [], ...props } });
+    wrapper = shallowMount(AreaChart, {
+      propsData: { option: { series: [] }, data: [], ...props },
+      stubs: {
+        'chart-tooltip': ChartTooltipStub,
+      },
+    });
     emitChartCreated();
   };
 
   beforeEach(() => {
-    option = {
-      series: [],
-    };
-
-    mockChartInstance = {
-      getDom: () => {
-        return {
-          addEventListener: jest.fn(),
-          removeEventListener: jest.fn(),
-        };
-      },
-      on: jest.fn(),
-      off: jest.fn(),
-      convertToPixel: jest.fn(),
-      getOption: () => {
-        return option;
-      },
-    };
-  });
-
-  afterEach(() => {
-    wrapper.destroy();
+    mockChartInstance = createMockChartInstance();
   });
 
   it('emits `created`, with the chart instance', async () => {

package/src/components/charts/area/area.vue

@@ -345,8 +345,9 @@ export default {
       :left="annotationsTooltipPosition.left"
       placement="bottom"
     >
-      <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-      <div slot="title">{{ annotationsTooltipTitle }}</div>
+      <template #title>
+        <div>{{ annotationsTooltipTitle }}</div>
+      </template>
       <div>{{ annotationsTooltipContent }}</div>
     </chart-tooltip>
     <chart-tooltip
@@ -359,19 +360,15 @@ export default {
       :top="dataTooltipPosition.top"
       :left="dataTooltipPosition.left"
     >
-      <template v-if="formatTooltipText">
-        <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-        <slot slot="title" name="tooltip-title"></slot>
-        <slot name="tooltip-content"></slot>
-      </template>
-      <template v-else>
-        <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-        <div slot="title">
+      <template #title>
+        <slot v-if="formatTooltipText" name="tooltip-title"></slot>
+        <template v-else>
           {{ dataTooltipTitle }}
           <template v-if="options.xAxis.name">({{ options.xAxis.name }})</template>
-        </div>
-        <tooltip-default-format :tooltip-content="dataTooltipContent" />
+        </template>
       </template>
+      <slot v-if="formatTooltipText" name="tooltip-content"></slot>
+      <tooltip-default-format v-else :tooltip-content="dataTooltipContent" />
     </chart-tooltip>
     <chart-legend
       v-if="compiledOptions"

package/src/components/charts/bar/bar.spec.js

@@ -2,16 +2,9 @@ import { shallowMount } from '@vue/test-utils';
 import Chart from '../chart/chart.vue';
 import BarChart from './bar.vue';
 import TooltipDefaultFormat from '~/components/shared_components/charts/tooltip_default_format.vue';
+import { createMockChartInstance } from '~helpers/chart_stubs';
 
-const mockChartInstance = {
-  getDom: () => {
-    return {
-      addEventListener: jest.fn(),
-      removeEventListener: jest.fn(),
-    };
-  },
-  convertToPixel: jest.fn(),
-};
+let mockChartInstance;
 
 jest.mock('echarts', () => ({
   getInstanceByDom: () => mockChartInstance,
@@ -45,8 +38,8 @@ describe('Bar chart component', () => {
     });
   };
 
-  afterEach(() => {
-    wrapper.destroy();
+  beforeEach(() => {
+    mockChartInstance = createMockChartInstance();
   });
 
   describe('when mounted', () => {

package/src/components/charts/chart/chart.spec.js

@@ -25,10 +25,6 @@ describe('chart component', () => {
     wrapper = shallowMount(...mountArgs);
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   it('initializes chart using $refs.chart', () => {
     expect(echarts.init).toHaveBeenCalledWith(
       wrapper.findComponent({ ref: 'chart' }).element,

package/src/components/charts/column/column_chart.spec.js

@@ -52,10 +52,6 @@ describe('column chart component', () => {
     factory();
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   it('emits "created" when onCreated is called', () => {
     wrapper.vm.onCreated(wrapper.vm.chart);
 

package/src/components/charts/discrete_scatter/discrete_scatter.stories.js

@@ -13,6 +13,7 @@ const template = `
     :option="option"
     :y-axis-title="yAxisTitle"
     :x-axis-title="xAxisTitle"
+    data-testid="discrete-scatter-chart"
   />
 `;
 

package/src/components/charts/discrete_scatter/discrete_scatter.vue

@@ -174,16 +174,13 @@ export default {
       :top="tooltipPosition.top"
       :left="tooltipPosition.left"
     >
-      <template v-if="formatTooltipText">
-        <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-        <slot slot="title" name="tooltip-title"></slot>
-        <slot name="tooltip-content"></slot>
+      <template #title>
+        <slot name="tooltip-title">{{ tooltipTitle }} ({{ xAxisTitle }})</slot>
       </template>
-      <template v-else>
-        <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-        <div slot="title">{{ tooltipTitle }} ({{ xAxisTitle }})</div>
+
+      <slot name="tooltip-content">
         <tooltip-default-format :tooltip-content="tooltipContent" />
-      </template>
+      </slot>
     </chart-tooltip>
   </div>
 </template>

package/src/components/charts/gauge/gauge.spec.js

@@ -1,8 +1,8 @@
 import { shallowMount } from '@vue/test-utils';
-
 import { gaugeSafeHues, gaugeWarningHue } from '../../../utils/charts/theme';
 import Chart from '../chart/chart.vue';
 import GlGauge from './gauge.vue';
+import { createMockChartInstance } from '~helpers/chart_stubs';
 
 const placeholder = '--';
 
@@ -20,7 +20,6 @@ jest.mock('echarts', () => ({
 
 describe('gauge component', () => {
   let wrapper;
-  let options;
 
   const findChart = () => wrapper.findComponent(Chart);
   const findChartOptions = () => findChart().props('options');
@@ -38,28 +37,7 @@ describe('gauge component', () => {
   };
 
   beforeEach(() => {
-    options = {
-      series: [],
-    };
-
-    mockChartInstance = {
-      getDom: () => {
-        return {
-          addEventListener: jest.fn(),
-          removeEventListener: jest.fn(),
-        };
-      },
-      on: jest.fn(),
-      off: jest.fn(),
-      convertToPixel: jest.fn(),
-      getOption: () => {
-        return options;
-      },
-    };
-  });
-
-  afterEach(() => {
-    wrapper.destroy();
+    mockChartInstance = createMockChartInstance();
   });
 
   it('emits `created`, with the chart instance', () => {

package/src/components/charts/heatmap/heatmap.spec.js

@@ -4,6 +4,7 @@ import Chart from '../chart/chart.vue';
 import ChartTooltip from '../tooltip/tooltip.vue';
 import HeatMapChart from './heatmap.vue';
 import { TOOLTIP_LEFT_OFFSET } from '~/utils/charts/constants';
+import { createMockChartInstance } from '~helpers/chart_stubs';
 
 let mockChartInstance;
 
@@ -13,7 +14,6 @@ jest.mock('echarts', () => ({
 
 describe('heatmap component', () => {
   let wrapper;
-  let options;
 
   const findChart = () => wrapper.findComponent(Chart);
   const findChartTooltip = () => wrapper.findComponent(ChartTooltip);
@@ -22,33 +22,16 @@ describe('heatmap component', () => {
   const emitChartCreated = () => findChart().vm.$emit('created', mockChartInstance);
 
   beforeEach(() => {
-    options = {
-      series: [],
-    };
-
-    mockChartInstance = {
-      getDom: () => {
-        return {
-          addEventListener: jest.fn(),
-          removeEventListener: jest.fn(),
-        };
-      },
-      convertToPixel: jest.fn(),
-      getOption: () => {
-        return options;
-      },
-    };
-
-    wrapper = shallowMount(HeatMapChart, { propsData: { options, dataSeries: [] } });
+    mockChartInstance = createMockChartInstance();
+
+    wrapper = shallowMount(HeatMapChart, {
+      propsData: { options: { series: [] }, dataSeries: [] },
+    });
     emitChartCreated();
 
     return wrapper.vm.$nextTick();
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   it('emits `created`, with the chart instance', () => {
     expect(wrapper.emitted('created').length).toBe(1);
     expect(wrapper.emitted('created')[0][0]).toBe(mockChartInstance);

package/src/components/charts/legend/legend.spec.js

@@ -2,16 +2,13 @@ import { shallowMount } from '@vue/test-utils';
 import Chart from '../chart/chart.vue';
 import GlChartSeriesLabel from '../series_label/series_label.vue';
 import Legend from './legend.vue';
+import { createMockChartInstance } from '~helpers/chart_stubs';
+
+let mockChartInstance;
 
 jest.mock('echarts', () => ({
-  getInstanceByDom: jest.fn((instance) => instance),
-  init: jest.fn(() => ({
-    dispatchAction: jest.fn(),
-    resize: jest.fn(),
-    setOption: jest.fn(),
-    on: jest.fn(),
-    off: jest.fn(),
-  })),
+  getInstanceByDom: () => mockChartInstance,
+  init: () => mockChartInstance,
   registerTheme: jest.fn(),
 }));
 
@@ -58,24 +55,21 @@ describe('chart legend component', () => {
     legendWrapper = shallowMount(Legend, {
       propsData: {
         ...propsData,
-        chart,
+        chart: mockChartInstance,
         seriesInfo,
       },
     });
   };
 
   beforeEach(async () => {
+    mockChartInstance = createMockChartInstance();
+
     chartWrapper = shallowMount(...chartArgs);
     await chartWrapper.vm.$nextTick();
     // Runs after mounting the chart so that it has an up to date reference
     buildLegend();
   });
 
-  afterEach(() => {
-    chartWrapper.destroy();
-    legendWrapper.destroy();
-  });
-
   it('renders the legend with no errors', () => {
     expect(legendWrapper.exists()).toBe(true);
   });

package/src/components/charts/line/line.spec.js

@@ -6,6 +6,8 @@ import LineChart from './line.vue';
 
 import { LEGEND_LAYOUT_INLINE, LEGEND_LAYOUT_TABLE } from '~/utils/charts/constants';
 
+import { createMockChartInstance, ChartTooltipStub } from '~helpers/chart_stubs';
+
 let mockChartInstance;
 
 jest.mock('echarts', () => ({
@@ -23,36 +25,16 @@ describe('line component', () => {
 
   const emitChartCreated = () => findChart().vm.$emit('created', mockChartInstance);
 
-  const createShallowWrapper = (props = {}) => {
+  const createShallowWrapper = (props = {}, mountOptions = {}) => {
     wrapper = shallowMount(LineChart, {
       propsData: { option, data: [], ...props },
+      ...mountOptions,
     });
     emitChartCreated();
   };
 
   beforeEach(() => {
-    option = {
-      series: [],
-    };
-
-    mockChartInstance = {
-      getDom: () => {
-        return {
-          addEventListener: jest.fn(),
-          removeEventListener: jest.fn(),
-        };
-      },
-      on: jest.fn(),
-      off: jest.fn(),
-      convertToPixel: jest.fn(),
-      getOption: () => {
-        return option;
-      },
-    };
-  });
-
-  afterEach(() => {
-    wrapper.destroy();
+    mockChartInstance = createMockChartInstance();
   });
 
   it('emits `created`, with the chart instance', async () => {
@@ -128,14 +110,21 @@ describe('line component', () => {
         },
       };
 
-      createShallowWrapper({
-        annotations: [
-          {
-            min: '',
-            max: '',
+      createShallowWrapper(
+        {
+          annotations: [
+            {
+              min: '',
+              max: '',
+            },
+          ],
+        },
+        {
+          stubs: {
+            'chart-tooltip': ChartTooltipStub,
           },
-        ],
-      });
+        }
+      );
 
       wrapper.vm.onChartDataPointMouseOver(params);
 

package/src/components/charts/line/line.vue

@@ -339,8 +339,9 @@ export default {
       :left="annotationsTooltipPosition.left"
       placement="bottom"
     >
-      <!-- eslint-disable-next-line vue/no-deprecated-slot-attribute -->
-      <div slot="title">{{ annotationsTooltipTitle }}</div>
+      <template #title>
+        <div>{{ annotationsTooltipTitle }}</div>
+      </template>
       <div>{{ annotationsTooltipContent }}</div>
     </chart-tooltip>
     <chart-tooltip

package/src/components/charts/single_stat/single_stat.spec.js

@@ -26,10 +26,6 @@ describe('GlSingleStat', () => {
 
   const findIemByTestId = (testId) => wrapper.find(`[data-testid="${testId}"]`);
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   describe('displays the correct default data', () => {
     beforeEach(() => createWrapper());
 

package/src/components/charts/sparkline/sparkline.spec.js

@@ -2,14 +2,13 @@ import { shallowMount, createLocalVue } from '@vue/test-utils';
 import Chart from '../chart/chart.vue';
 import SparklineChart from './sparkline.vue';
 import { waitForAnimationFrame } from '~/utils/test_utils';
+import { createMockChartInstance, ChartTooltipStub } from '~helpers/chart_stubs';
 
-const mockResize = jest.fn();
-const mockChartInstance = {
-  subscribedEvents: {},
-  getDom: () => {},
-  convertToPixel: () => [],
-  resize: mockResize,
-};
+let mockChartInstance;
+
+jest.mock('echarts', () => ({
+  getInstanceByDom: () => mockChartInstance,
+}));
 
 let triggerResize = () => {};
 jest.mock('~/directives/resize_observer/resize_observer', () => ({
@@ -22,11 +21,6 @@ jest.mock('~/directives/resize_observer/resize_observer', () => ({
 
 const localVue = createLocalVue();
 
-const ChartToolTipStub = {
-  name: 'chart-tooltip-stub',
-  template: '<div><slot name="default"></slot><slot name="title"></slot></div>',
-};
-
 describe('sparkline chart component', () => {
   let wrapper;
   let componentOptions;
@@ -39,7 +33,7 @@ describe('sparkline chart component', () => {
       },
       scopedSlots: { latestSeriesEntry: jest.fn() },
       stubs: {
-        'chart-tooltip': ChartToolTipStub,
+        'chart-tooltip': ChartTooltipStub,
       },
     };
 
@@ -50,7 +44,7 @@ describe('sparkline chart component', () => {
   const getByTestId = (id) => wrapper.find(`[data-testid="${id}"]`);
   const getChart = () => wrapper.findComponent(Chart);
 
-  const getTooltip = () => wrapper.findComponent(ChartToolTipStub);
+  const getTooltip = () => wrapper.findComponent(ChartTooltipStub);
   const getTooltipTitle = () => getByTestId('tooltip-title');
   const getTooltipContent = () => getByTestId('tooltip-content');
 
@@ -72,13 +66,13 @@ describe('sparkline chart component', () => {
   const emitChartCreated = () => getChart().vm.$emit('created', mockChartInstance);
 
   beforeEach(() => {
+    mockChartInstance = createMockChartInstance();
     factory();
     // needs to run after every mount, or the chart-instance is `null` and `beforeDestroy` throws
     emitChartCreated();
   });
 
   afterEach(() => {
-    wrapper.destroy();
     jest.clearAllMocks();
   });
 

package/src/components/charts/stacked_column/stacked_column.spec.js

@@ -56,7 +56,6 @@ describe('stacked column chart component', () => {
   });
 
   afterEach(() => {
-    wrapper.destroy();
     jest.restoreAllMocks();
   });
 

package/src/components/shared_components/clear_icon_button/clear_icon_button.spec.js

@@ -17,10 +17,6 @@ describe('Clear Icon Button', () => {
     createComponent();
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   it('renders successfully', () => {
     expect(wrapper.element).toMatchSnapshot();
   });

package/src/components/shared_components/close_button/close_button.spec.js

@@ -16,10 +16,6 @@ describe('Clear Icon Button', () => {
     createComponent();
   });
 
-  afterEach(() => {
-    wrapper.destroy();
-  });
-
   it('renders successfully', () => {
     expect(wrapper.element).toMatchSnapshot();
   });