@gitlab/ui 67.5.1 → 68.0.0

package/dist/tokens/css/tokens.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Fri, 03 Nov 2023 15:03:12 GMT
+ * Generated on Tue, 07 Nov 2023 12:38:00 GMT
  */
 
 :root {

package/dist/tokens/css/tokens.dark.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Fri, 03 Nov 2023 15:03:12 GMT
+ * Generated on Tue, 07 Nov 2023 12:38:00 GMT
  */
 
 :root.gl-dark {

package/dist/tokens/js/tokens.dark.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Fri, 03 Nov 2023 15:03:12 GMT
+ * Generated on Tue, 07 Nov 2023 12:38:00 GMT
  */
 
 export const BLACK = "#fff";

package/dist/tokens/js/tokens.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Fri, 03 Nov 2023 15:03:12 GMT
+ * Generated on Tue, 07 Nov 2023 12:38:00 GMT
  */
 
 export const BLACK = "#000";

package/dist/tokens/scss/_tokens.dark.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Fri, 03 Nov 2023 15:03:12 GMT
+// Generated on Tue, 07 Nov 2023 12:38:00 GMT
 
 $red-950: #fff4f3;
 $red-900: #fcf1ef;

package/dist/tokens/scss/_tokens.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Fri, 03 Nov 2023 15:03:12 GMT
+// Generated on Tue, 07 Nov 2023 12:38:00 GMT
 
 $gl-line-height-52: 3.25rem;
 $gl-line-height-44: 2.75rem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "67.5.1",
+  "version": "68.0.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -124,9 +124,10 @@
     "bootstrap": "4.6.2",
     "cypress": "13.4.0",
     "cypress-axe": "^1.4.0",
+    "cypress-real-events": "^1.11.0",
     "dompurify": "^3.0.0",
     "emoji-regex": "^10.0.0",
-    "eslint": "8.52.0",
+    "eslint": "8.53.0",
     "eslint-import-resolver-jest": "3.0.2",
     "eslint-plugin-cypress": "2.15.1",
     "eslint-plugin-storybook": "0.6.15",

package/src/components/charts/legend/legend.scss

@@ -17,7 +17,7 @@ $legend-body-h: $gl-spacing-scale-13 - $gl-spacing-scale-4;
 .gl-legend-tabular,
 .gl-chart-h-auto .gl-legend-inline {
   &::after {
-    background-image: linear-gradient(to bottom, $transparent-rgba, $white);
+    background-image: linear-gradient(to bottom, $transparent-rgba, var(--white, #{$white}));
     @include gl-bottom-0;
     @include gl-content-empty;
     @include gl-display-block;
@@ -31,7 +31,6 @@ $legend-body-h: $gl-spacing-scale-13 - $gl-spacing-scale-4;
     @include gl-display-flex;
     @include gl-flex-wrap;
     @include gl-flex-shrink-0;
-    @include gl-text-gray-900;
 
   .gl-legend-inline-series {
     @include gl-display-flex;
@@ -75,14 +74,14 @@ $legend-body-h: $gl-spacing-scale-13 - $gl-spacing-scale-4;
   .gl-legend-tabular-body {
     height: $legend-body-h;
     @include gl-overflow-y-auto;
-
-    > *:nth-child(odd) {
-      @include gl-bg-gray-10;
-    }
   }
 
   .gl-legend-tabular-row {
     @include gl-display-flex;
+    
+    &:nth-child(odd) {
+      background-color: var(--gray-50, #{$gray-50});
+    }
   }
 
   .gl-legend-tabular-title-cell,

package/src/components/experimental/duo/chat/duo_chat.spec.js

@@ -160,12 +160,25 @@ describe('GlDuoChat', () => {
     });
 
     it('sets correct props on the Experiment badge', () => {
-      const experimentHelpPageUrl = 'https://foo.bar';
+      const badgeHelpPageUrl = 'https://foo.bar';
       const containerId = 'chat-component';
-      createComponent({ propsData: { experimentHelpPageUrl } });
-      expect(findBadge().props('experimentHelpPageUrl')).toBe(experimentHelpPageUrl);
+      createComponent({ propsData: { badgeHelpPageUrl } });
+      expect(findBadge().props('helpPageUrl')).toBe(badgeHelpPageUrl);
       expect(findBadge().attributes('container-id')).toBe(containerId);
     });
+
+    it.each`
+      badgeType       | expectedProp
+      ${'experiment'} | ${'experiment'}
+      ${'beta'}       | ${'beta'}
+      ${undefined}    | ${'experiment'}
+    `(
+      'sets correct props on the Experiment badge when badgeType is "$badgeType"',
+      ({ badgeType, expectedProp }) => {
+        createComponent({ propsData: { badgeType } });
+        expect(findBadge().props('type')).toBe(expectedProp);
+      }
+    );
   });
 
   describe('chat', () => {

package/src/components/experimental/duo/chat/duo_chat.stories.js

@@ -24,7 +24,8 @@ const generateProps = ({
   isLoading = defaultValue('isLoading'),
   isChatAvailable = defaultValue('isChatAvailable'),
   predefinedPrompts = defaultValue('predefinedPrompts'),
-  experimentHelpPageUrl = defaultValue('experimentHelpPageUrl'),
+  badgeHelpPageUrl = defaultValue('badgeHelpPageUrl'),
+  badgeType = defaultValue('badgeType'),
   toolName = defaultValue('toolName'),
 } = {}) => ({
   title,
@@ -33,7 +34,8 @@ const generateProps = ({
   isLoading,
   isChatAvailable,
   predefinedPrompts,
-  experimentHelpPageUrl,
+  badgeHelpPageUrl,
+  badgeType,
   toolName,
 });
 
@@ -52,7 +54,8 @@ export const Default = (args, { argTypes }) => ({
       :is-loading="isLoading"
       :is-chat-available="isChatAvailable"
       :predefined-prompts="predefinedPrompts"
-      :experiment-help-page-url="experimentHelpPageUrl"
+      :badge-help-page-url="badgeHelpPageUrl"
+      :badge-type="badgeType"
       :tool-name="toolName"
     />`,
 });
@@ -145,7 +148,8 @@ export const Interactive = (args, { argTypes }) => ({
       :is-loading="promptInFlight"
       :is-chat-available="isChatAvailable"
       :predefined-prompts="predefinedPrompts"
-      :experiment-help-page-url="experimentHelpPageUrl"
+      :badge-help-page-url="badgeHelpPageUrl"
+      :badge-type="badgeType"
       :tool-name="toolName"
       @send-chat-prompt="onSendChatPrompt"
       @chat-hidden="onChatHidden"
@@ -170,7 +174,8 @@ export const Slots = (args, { argTypes }) => ({
         :is-loading="isLoading"
         :is-chat-available="isChatAvailable"
         :predefined-prompts="predefinedPrompts"
-        :experiment-help-page-url="experimentHelpPageUrl"
+        :badge-help-page-url="badgeHelpPageUrl"
+        :badge-type="badgeType"
         :tool-name="toolName">
 
         <template #hero>

package/src/components/experimental/duo/chat/duo_chat.vue

@@ -9,6 +9,7 @@ import GlFormTextarea from '../../../base/form/form_textarea/form_textarea.vue';
 import GlForm from '../../../base/form/form.vue';
 import GlFormText from '../../../base/form/form_text/form_text.vue';
 import GlExperimentBadge from '../../experiment_badge/experiment_badge.vue';
+import { badgeTypes, badgeTypeValidator } from '../../experiment_badge/constants';
 import { SafeHtmlDirective as SafeHtml } from '../../../../directives/safe_html/safe_html';
 import GlDuoChatLoader from './components/duo_chat_loader/duo_chat_loader.vue';
 import GlDuoChatPredefinedPrompts from './components/duo_chat_predefined_prompts/duo_chat_predefined_prompts.vue';
@@ -106,13 +107,22 @@ export default {
       default: () => i18n.CHAT_DEFAULT_PREDEFINED_PROMPTS,
     },
     /**
-     * URL to the experiment help page. This is passed down to the `GlExperimentBadge` component. Refer that component for more information.
+     * URL to the experiment/beta help page. This is passed down to the `GlExperimentBadge` component. Refer that component for more information.
      */
-    experimentHelpPageUrl: {
+    badgeHelpPageUrl: {
       type: String,
       required: false,
       default: '',
     },
+    /**
+     * The type of the badge. This is passed down to the `GlExperimentBadge` component. Refer that component for more information.
+     */
+    badgeType: {
+      type: String,
+      required: false,
+      default: badgeTypes[0],
+      validator: badgeTypeValidator,
+    },
     /**
      * The current tool's name to display in the loading message while waiting for a response from AI. Refer the `GlDuoChatLoader` component for more information.
      */
@@ -236,7 +246,8 @@ export default {
       >
         <h3 class="gl-my-0 gl-font-size-h2">{{ title }}</h3>
         <gl-experiment-badge
-          :experiment-help-page-url="experimentHelpPageUrl"
+          :help-page-url="badgeHelpPageUrl"
+          :type="badgeType"
           container-id="chat-component"
         />
         <gl-button

package/src/components/experimental/experiment_badge/constants.js

@@ -0,0 +1,2 @@
+export const badgeTypes = ['experiment', 'beta'];
+export const badgeTypeValidator = (value) => badgeTypes.includes(value);

package/src/components/experimental/experiment_badge/experiment_badge.spec.js

@@ -34,19 +34,6 @@ describe('GlExperimentBadge', () => {
     expect(findPopover().exists()).toBe(true);
   });
 
-  it('sets correct props on the badge', () => {
-    const badgeType = 'neutral';
-    const badgeSize = 'md';
-    expect(findBadge().props('variant')).toBe(badgeType);
-    expect(findBadge().props('size')).toBe(badgeSize);
-    expect(findBadge().find('span').text()).toBe(i18n.EXPERIMENT_BADGE);
-  });
-
-  it('sets correct props on the popover', () => {
-    expect(findPopover().props('triggers')).toBe('click');
-    expect(findPopover().props('title')).toBe(i18n.EXPERIMENT_POPOVER_TITLE);
-  });
-
   it('correctly sets the placement of the popover', () => {
     const popoverPlacement = 'right';
     createComponent({ popoverPlacement });
@@ -54,13 +41,37 @@ describe('GlExperimentBadge', () => {
   });
 
   it('sets the link to the help page if passed', () => {
-    const experimentHelpPageUrl = 'https://gitlab.com';
-    createComponent({ experimentHelpPageUrl });
-    expect(findHelpLink().attributes('href')).toBe(experimentHelpPageUrl);
+    const helpPageUrl = 'https://gitlab.com';
+    createComponent({ helpPageUrl });
+    expect(findHelpLink().attributes('href')).toBe(helpPageUrl);
   });
 
   it('generates the unique ID to connect the button and the popover', () => {
     expect(findBadge().attributes('id')).toBe('fakeUniqueId');
     expect(findPopover().attributes('target')).toBe('fakeUniqueId');
   });
+
+  describe.each`
+    type            | expectedType
+    ${'beta'}       | ${'beta'}
+    ${'experiment'} | ${'experiment'}
+    ${undefined}    | ${'experiment'}
+  `('when type is %s', ({ type, expectedType } = {}) => {
+    beforeEach(() => {
+      createComponent({ type });
+    });
+
+    it('sets correct props on the badge', () => {
+      const badgeVariant = 'neutral';
+      const badgeSize = 'md';
+      expect(findBadge().props('variant')).toBe(badgeVariant);
+      expect(findBadge().props('size')).toBe(badgeSize);
+      expect(findBadge().find('span').text()).toBe(i18n[expectedType].BADGE);
+    });
+
+    it('sets correct props on the popover', () => {
+      expect(findPopover().props('triggers')).toBe('click');
+      expect(findPopover().props('title')).toBe(i18n[expectedType].POPOVER_TITLE);
+    });
+  });
 });

package/src/components/experimental/experiment_badge/experiment_badge.stories.js

@@ -4,11 +4,13 @@ import readme from './experiment_badge.md';
 const defaultValue = (prop) => GlExperimentBadge.props[prop].default;
 
 const generateProps = ({
-  experimentHelpPageUrl = defaultValue('experimentHelpPageUrl'),
+  helpPageUrl = defaultValue('helpPageUrl'),
   popoverPlacement = defaultValue('popoverPlacement'),
+  type = defaultValue('type'),
 } = {}) => ({
-  experimentHelpPageUrl,
+  helpPageUrl,
   popoverPlacement,
+  type,
 });
 
 const Template = (args, { argTypes }) => ({
@@ -17,8 +19,9 @@ const Template = (args, { argTypes }) => ({
   template: `
     <div class='gl-h-13'>
       <gl-experiment-badge
-        :experiment-help-page-url='experimentHelpPageUrl'
-        :popover-placement='popoverPlacement' />
+        :help-page-url='helpPageUrl'
+        :popover-placement='popoverPlacement'
+        :type='type' />
     </div>
   `,
 });

package/src/components/experimental/experiment_badge/experiment_badge.vue

@@ -4,22 +4,36 @@ import GlBadge from '../../base/badge/badge.vue';
 import GlLink from '../../base/link/link.vue';
 import GlPopover from '../../base/popover/popover.vue';
 import GlSprintf from '../../utilities/sprintf/sprintf.vue';
+import { badgeTypes, badgeTypeValidator } from './constants';
 
 export const i18n = {
-  EXPERIMENT_BADGE: 'Experiment',
-  EXPERIMENT_POPOVER_TITLE: "What's an Experiment?",
-  EXPERIMENT_POPOVER_CONTENT:
-    "An %{linkStart}Experiment%{linkEnd} is a feature that's in the process of being developed. It's not production-ready. We encourage users to try Experimental features and provide feedback. An Experiment: %{bullets}",
-  EXPERIMENT_POPOVER_BULLETS: [
-    'May be unstable',
-    'Has no support and might not be documented',
-    'Can be removed at any time',
-  ],
+  experiment: {
+    BADGE: 'Experiment',
+    POPOVER_TITLE: "What's an Experiment?",
+    POPOVER_CONTENT:
+      "An %{linkStart}Experiment%{linkEnd} is a feature that's in the process of being developed. It's not production-ready. We encourage users to try Experimental features and provide feedback. An Experiment: %{bullets}",
+    POPOVER_BULLETS: [
+      'May be unstable',
+      'Has no support and might not be documented',
+      'Can be removed at any time',
+    ],
+  },
+  beta: {
+    BADGE: 'Beta',
+    POPOVER_TITLE: "What's a Beta?",
+    POPOVER_CONTENT:
+      "A %{linkStart}Beta%{linkEnd} feature is not production-ready, but is unlikely to change drastically before it's released. We encourage users to try Beta features and provide feedback.\nA Beta feature: %{bullets}",
+    POPOVER_BULLETS: [
+      'May be unstable',
+      'Should not cause data loss',
+      'Is supported by a commercially reasonable effort',
+      'Is complete or near completion',
+    ],
+  },
 };
 
 export default {
   name: 'GlExperimentBadge',
-  i18n,
   components: {
     GlBadge,
     GlPopover,
@@ -30,7 +44,7 @@ export default {
     /**
      * The URL of a page to provide more explanations on the experiment.
      */
-    experimentHelpPageUrl: {
+    helpPageUrl: {
       type: String,
       required: false,
       default: '',
@@ -43,6 +57,20 @@ export default {
       required: false,
       default: 'bottom',
     },
+    /**
+     * The type of the badge.
+     */
+    type: {
+      type: String,
+      required: false,
+      default: badgeTypes[0],
+      validator: badgeTypeValidator,
+    },
+  },
+  computed: {
+    activeType() {
+      return i18n[this.type];
+    },
   },
   created() {
     this.triggerId = uniqueId('experiment-badge-');
@@ -52,30 +80,25 @@ export default {
 
 <template>
   <gl-badge :id="triggerId" class="gl-mx-4 gl-hover-cursor-pointer" variant="neutral" size="md">
-    <span>{{ $options.i18n.EXPERIMENT_BADGE }}</span>
+    <span>{{ activeType.BADGE }}</span>
     <gl-popover
       triggers="click"
       show-close-button
       :placement="popoverPlacement"
       :target="triggerId"
       :css-classes="['gl-z-index-9999!']"
-      :title="$options.i18n.EXPERIMENT_POPOVER_TITLE"
+      :title="activeType.POPOVER_TITLE"
     >
-      <gl-sprintf :message="$options.i18n.EXPERIMENT_POPOVER_CONTENT">
+      <gl-sprintf :message="activeType.POPOVER_CONTENT">
         <template #link="{ content }">
-          <gl-link
-            v-if="experimentHelpPageUrl"
-            :href="experimentHelpPageUrl"
-            target="_blank"
-            class="gl-font-sm!"
-          >
+          <gl-link v-if="helpPageUrl" :href="helpPageUrl" target="_blank" class="gl-font-sm!">
             {{ content }}
           </gl-link>
           <span v-else>{{ content }}</span>
         </template>
         <template #bullets>
           <ul class="gl-mb-0 gl-pl-5">
-            <li v-for="(item, i) in $options.i18n.EXPERIMENT_POPOVER_BULLETS" :key="`li-${i}`">
+            <li v-for="(item, i) in activeType.POPOVER_BULLETS" :key="`li-${i}`">
               {{ item }}
             </li>
           </ul>

package/src/scss/storybook_dark_mode.scss

@@ -15,6 +15,9 @@
   // Note that we are assigning variables with different values due to the way GitLab inverts variables in dark mode.
   // e.g. text color is usually $gray-900, but in dark mode $gray-900 variable gets inverted to $gray-50
   --gl-text-color: #{$gray-50};
+  --white: #{$gray-900}; // define mapping between the colours in dark mode. I have used the values from GitLab for consistency: https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/themes/_dark.scss
+  --gray-10: #{$gray-950};
+  --gray-600: #{$gray-300};
 
   color-scheme: dark;