@gitlab/ui 66.13.1 → 66.14.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [66.14.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v66.13.1...v66.14.0) (2023-09-25)
+
+
+### Features
+
+* **GlExperimentBadge:** Implement component ([de360ee](https://gitlab.com/gitlab-org/gitlab-ui/commit/de360eec00fb772cb3c10258f246975832d68f34))
+
 ## [66.13.1](https://gitlab.com/gitlab-org/gitlab-ui/compare/v66.13.0...v66.13.1) (2023-09-25)
 
 

package/dist/components/experimental/experiment_badge/experiment_badge.js

@@ -0,0 +1,83 @@
+import uniqueId from 'lodash/uniqueId';
+import { GlBadge, GlPopover, GlLink } from '../../../index';
+import GlSprintf from '../../utilities/sprintf/sprintf';
+import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
+
+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']
+};
+var script = {
+  name: 'GlExperimentBadge',
+  i18n,
+  components: {
+    GlBadge,
+    GlPopover,
+    GlSprintf,
+    GlLink
+  },
+  props: {
+    /**
+     * The URL of a page to provide more explanations on the experiment.
+     */
+    experimentHelpPageUrl: {
+      type: String,
+      required: false,
+      default: ''
+    },
+    /**
+     * The placement of the popover in relation to the button.
+     */
+    popoverPlacement: {
+      type: String,
+      required: false,
+      default: 'bottom'
+    }
+  },
+  created() {
+    this.triggerId = uniqueId('experiment-badge-');
+  }
+};
+
+/* script */
+const __vue_script__ = script;
+
+/* template */
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('gl-badge',{staticClass:"gl-mx-4 gl-hover-cursor-pointer",attrs:{"id":_vm.triggerId,"variant":"neutral","size":"md"}},[_c('span',[_vm._v(_vm._s(_vm.$options.i18n.EXPERIMENT_BADGE))]),_vm._v(" "),_c('gl-popover',{attrs:{"triggers":"click","show-close-button":"","placement":_vm.popoverPlacement,"target":_vm.triggerId,"css-classes":['gl-z-index-9999!'],"title":_vm.$options.i18n.EXPERIMENT_POPOVER_TITLE}},[_c('gl-sprintf',{attrs:{"message":_vm.$options.i18n.EXPERIMENT_POPOVER_CONTENT},scopedSlots:_vm._u([{key:"link",fn:function(ref){
+var content = ref.content;
+return [(_vm.experimentHelpPageUrl)?_c('gl-link',{staticClass:"gl-font-sm!",attrs:{"href":_vm.experimentHelpPageUrl,"target":"_blank"}},[_vm._v("\n          "+_vm._s(content)+"\n        ")]):_c('span',[_vm._v(_vm._s(content))])]}},{key:"bullets",fn:function(){return [_c('ul',{staticClass:"gl-mb-0 gl-pl-5"},_vm._l((_vm.$options.i18n.EXPERIMENT_POPOVER_BULLETS),function(item,i){return _c('li',{key:("li-" + i)},[_vm._v("\n            "+_vm._s(item)+"\n          ")])}),0)]},proxy:true}])})],1)],1)};
+var __vue_staticRenderFns__ = [];
+
+  /* style */
+  const __vue_inject_styles__ = undefined;
+  /* scoped */
+  const __vue_scope_id__ = undefined;
+  /* module identifier */
+  const __vue_module_identifier__ = undefined;
+  /* functional template */
+  const __vue_is_functional_template__ = false;
+  /* style inject */
+  
+  /* style inject SSR */
+  
+  /* style inject shadow dom */
+  
+
+  
+  const __vue_component__ = __vue_normalize__(
+    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
+    __vue_inject_styles__,
+    __vue_script__,
+    __vue_scope_id__,
+    __vue_is_functional_template__,
+    __vue_module_identifier__,
+    false,
+    undefined,
+    undefined,
+    undefined
+  );
+
+export default __vue_component__;
+export { i18n };

package/dist/index.js

@@ -86,6 +86,7 @@ export { default as GlAccordion } from './components/base/accordion/accordion';
 export { default as GlAccordionItem } from './components/base/accordion/accordion_item';
 export { default as GlCarousel } from './components/base/carousel/carousel';
 export { default as GlCarouselSlide } from './components/base/carousel/carousel_slide';
+export { default as GlExperimentBadge } from './components/experimental/experiment_badge/experiment_badge';
 export { default as GlAnimatedNumber } from './components/utilities/animated_number/animated_number';
 export { default as GlFriendlyWrap } from './components/utilities/friendly_wrap/friendly_wrap';
 export { default as GlIntersperse } from './components/utilities/intersperse/intersperse';

package/dist/tokens/css/tokens.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Mon, 25 Sep 2023 19:08:19 GMT
+ * Generated on Mon, 25 Sep 2023 20:40:39 GMT
  */
 
 :root {

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

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Mon, 25 Sep 2023 19:08:19 GMT
+ * Generated on Mon, 25 Sep 2023 20:40:39 GMT
  */
 
 :root {

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

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Mon, 25 Sep 2023 19:08:19 GMT
+ * Generated on Mon, 25 Sep 2023 20:40:39 GMT
  */
 
 export const BLACK = "#fff";

package/dist/tokens/js/tokens.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Mon, 25 Sep 2023 19:08:19 GMT
+ * Generated on Mon, 25 Sep 2023 20:40:39 GMT
  */
 
 export const BLACK = "#000";

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

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Mon, 25 Sep 2023 19:08:19 GMT
+// Generated on Mon, 25 Sep 2023 20:40:39 GMT
 
 $red-950: #fff4f3;
 $red-900: #fcf1ef;

package/dist/tokens/scss/_tokens.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Mon, 25 Sep 2023 19:08:19 GMT
+// Generated on Mon, 25 Sep 2023 20:40:39 GMT
 
 $gl-line-height-52: 3.25rem;
 $gl-line-height-44: 2.75rem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "66.13.1",
+  "version": "66.14.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",

package/src/components/experimental/experiment_badge/experiment_badge.md

@@ -0,0 +1,9 @@
+The component is representing a badge, marking the experimental features.
+It is supposed to be used with the AI experiments, and comes with a popover explaining
+what experiment means.
+
+## Usage
+
+```html
+<gl-experiment-badge experiment-help-page-url="https://gitlab.com" popover-placement="bottom" />
+```

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

@@ -0,0 +1,66 @@
+import { shallowMount } from '@vue/test-utils';
+import GlBadge from '../../base/badge/badge.vue';
+import GlPopover from '../../base/popover/popover.vue';
+import GlLink from '../../base/link/link.vue';
+import GlSprintf from '../../utilities/sprintf/sprintf.vue';
+import GlExperimentBadge, { i18n } from './experiment_badge.vue';
+
+jest.mock('lodash/uniqueId', () => () => 'fakeUniqueId');
+
+describe('GlExperimentBadge', () => {
+  let wrapper;
+
+  const findBadge = () => wrapper.findComponent(GlBadge);
+  const findPopover = () => wrapper.findComponent(GlPopover);
+  const findHelpLink = () => wrapper.findComponent(GlLink);
+
+  const createComponent = (props = {}) => {
+    wrapper = shallowMount(GlExperimentBadge, {
+      propsData: {
+        ...props,
+      },
+      stubs: {
+        GlSprintf,
+      },
+    });
+  };
+
+  beforeEach(() => {
+    createComponent();
+  });
+
+  it('renders main components', () => {
+    expect(findBadge().exists()).toBe(true);
+    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 });
+    expect(findPopover().props('placement')).toBe(popoverPlacement);
+  });
+
+  it('sets the link to the help page if passed', () => {
+    const experimentHelpPageUrl = 'https://gitlab.com';
+    createComponent({ experimentHelpPageUrl });
+    expect(findHelpLink().attributes('href')).toBe(experimentHelpPageUrl);
+  });
+
+  it('generates the unique ID to connect the button and the popover', () => {
+    expect(findBadge().attributes('id')).toBe('fakeUniqueId');
+    expect(findPopover().attributes('target')).toBe('fakeUniqueId');
+  });
+});

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

@@ -0,0 +1,56 @@
+import GlExperimentBadge from './experiment_badge.vue';
+import readme from './experiment_badge.md';
+
+const defaultValue = (prop) => GlExperimentBadge.props[prop].default;
+
+const generateProps = ({
+  experimentHelpPageUrl = defaultValue('experimentHelpPageUrl'),
+  popoverPlacement = defaultValue('popoverPlacement'),
+} = {}) => ({
+  experimentHelpPageUrl,
+  popoverPlacement,
+});
+
+const Template = (args, { argTypes }) => ({
+  components: { GlExperimentBadge },
+  props: Object.keys(argTypes),
+  template: `
+    <div class='gl-h-13'>
+      <gl-experiment-badge
+        :experiment-help-page-url='experimentHelpPageUrl'
+        :popover-placement='popoverPlacement' />
+    </div>
+  `,
+});
+
+export const Default = Template.bind({});
+Default.args = generateProps();
+
+export const WithHelpPageUrl = Template.bind({});
+WithHelpPageUrl.args = {
+  ...generateProps({
+    experimentHelpPageUrl:
+      'https://docs.gitlab.com/ee/policy/experiment-beta-support.html#experiment',
+  }),
+};
+
+export const CustomPlacement = Template.bind({});
+CustomPlacement.args = {
+  ...generateProps({
+    popoverPlacement: 'right',
+  }),
+};
+
+export default {
+  title: 'experimental/experiment_badge',
+  component: GlExperimentBadge,
+  parameters: {
+    storyshots: { disable: true },
+    docs: {
+      description: {
+        component: readme,
+      },
+    },
+  },
+  argTypes: {},
+};

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

@@ -0,0 +1,84 @@
+<script>
+import uniqueId from 'lodash/uniqueId';
+import { GlBadge, GlLink, GlPopover } from '../../../index';
+import GlSprintf from '../../utilities/sprintf/sprintf.vue';
+
+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',
+  ],
+};
+
+export default {
+  name: 'GlExperimentBadge',
+  i18n,
+  components: {
+    GlBadge,
+    GlPopover,
+    GlSprintf,
+    GlLink,
+  },
+  props: {
+    /**
+     * The URL of a page to provide more explanations on the experiment.
+     */
+    experimentHelpPageUrl: {
+      type: String,
+      required: false,
+      default: '',
+    },
+    /**
+     * The placement of the popover in relation to the button.
+     */
+    popoverPlacement: {
+      type: String,
+      required: false,
+      default: 'bottom',
+    },
+  },
+  created() {
+    this.triggerId = uniqueId('experiment-badge-');
+  },
+};
+</script>
+
+<template>
+  <gl-badge :id="triggerId" class="gl-mx-4 gl-hover-cursor-pointer" variant="neutral" size="md">
+    <span>{{ $options.i18n.EXPERIMENT_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"
+    >
+      <gl-sprintf :message="$options.i18n.EXPERIMENT_POPOVER_CONTENT">
+        <template #link="{ content }">
+          <gl-link
+            v-if="experimentHelpPageUrl"
+            :href="experimentHelpPageUrl"
+            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}`">
+              {{ item }}
+            </li>
+          </ul>
+        </template>
+      </gl-sprintf>
+    </gl-popover>
+  </gl-badge>
+</template>

package/src/index.js

@@ -96,6 +96,9 @@ export { default as GlAccordionItem } from './components/base/accordion/accordio
 export { default as GlCarousel } from './components/base/carousel/carousel.vue';
 export { default as GlCarouselSlide } from './components/base/carousel/carousel_slide.vue';
 
+// Experimental
+export { default as GlExperimentBadge } from './components/experimental/experiment_badge/experiment_badge.vue';
+
 // Utilities
 export { default as GlAnimatedNumber } from './components/utilities/animated_number/animated_number.vue';
 export { default as GlFriendlyWrap } from './components/utilities/friendly_wrap/friendly_wrap.vue';