@gitlab/ui 53.3.0 → 54.0.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# [54.0.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v53.3.0...v54.0.0) (2023-01-24)
+
+
+### Features
+
+* **GlDisclosureDropdown:** Loosen action item type ([bb2b308](https://gitlab.com/gitlab-org/gitlab-ui/commit/bb2b3087c6d322aa0b67b7343b854a0796d27fde))
+* **GlDisclosureDropdown:** Pass item to action ([8ac2cbf](https://gitlab.com/gitlab-org/gitlab-ui/commit/8ac2cbf80f81b4eff58e58a339b9fcad7bf40545))
+
+
+### BREAKING CHANGES
+
+* **GlDisclosureDropdown:** Action items are now determined by the *lack* of an
+href string. An item with an href string is rendered as a link item,
+whether or not it has an action callback.
+
+Before this change, if an item had *both* an href and an action, it
+would render as a button. Now, it would render as an anchor.
+* **GlDisclosureDropdown:** The `this` of the `GlDisclosureDropdown` action
+callback is now `undefined` rather than the item it's attached to. It
+now receives the item as a regular argument instead.
+
+This makes it more similar to the `action` event that's emitted by the
+component, such that the same function could be used in either way.
+
+This also means that the same callback can be attached to all items,
+instead of requiring a unique callback for each item.
+
 # [53.3.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v53.2.0...v53.3.0) (2023-01-24)
 
 

package/dist/components/base/new_dropdowns/disclosure/disclosure_dropdown_item.js

@@ -15,31 +15,37 @@ var script = {
     }
   },
   computed: {
-    isActionItem() {
+    isLink() {
       var _this$item;
-      return (_this$item = this.item) === null || _this$item === void 0 ? void 0 : _this$item.action;
+      return typeof ((_this$item = this.item) === null || _this$item === void 0 ? void 0 : _this$item.href) === 'string';
     },
     isCustomContent() {
       return Boolean(this.$scopedSlots.default);
     },
     itemComponent() {
-      if (this.isActionItem) return {
-        is: 'button',
+      const {
+        item
+      } = this;
+      if (this.isLink) return {
+        is: 'a',
         attrs: {
-          ...this.item.extraAttrs,
-          type: 'button'
+          href: item.href,
+          ...item.extraAttrs
         },
-        listeners: {
-          click: () => this.item.action()
-        }
+        listeners: {}
       };
       return {
-        is: 'a',
+        is: 'button',
         attrs: {
-          href: this.item.href,
-          ...this.item.extraAttrs
+          ...item.extraAttrs,
+          type: 'button'
         },
-        listeners: {}
+        listeners: {
+          click: () => {
+            var _item$action;
+            return (_item$action = item.action) === null || _item$action === void 0 ? void 0 : _item$action.call(undefined, item);
+          }
+        }
       };
     }
   },

package/dist/components/base/new_dropdowns/disclosure/utils.js

@@ -1,10 +1,6 @@
-const itemValidator = _ref => {
-  let {
-    text,
-    href,
-    action
-  } = _ref;
-  return Boolean((text === null || text === void 0 ? void 0 : text.length) && ((href === null || href === void 0 ? void 0 : href.length) || typeof action === 'function'));
+const itemValidator = item => {
+  var _item$text;
+  return (item === null || item === void 0 ? void 0 : (_item$text = item.text) === null || _item$text === void 0 ? void 0 : _item$text.length) > 0 && !Array.isArray(item === null || item === void 0 ? void 0 : item.items);
 };
 const isItem = item => Boolean(item) && itemValidator(item);
 const isGroup = group => Boolean(group) && Array.isArray(group.items) && Boolean(group.items.length) && group.items.every(isItem);

package/dist/index.js

@@ -86,7 +86,6 @@ 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 RichTextEditor } from './components/editors/rich_text_editor/rich_text_editor';
 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/package.json

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

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown.md

@@ -44,8 +44,12 @@ After closing, `GlDisclosureDropdown` emits a `hidden` event.
 
 ### Setting disclosure dropdown items
 
-Use the `items` prop to provide actions/links to the disclosure dropdown. Each item can be
-either an item or a group. For `Item`s, either the `href` or the `action` may be null, but not both.
+Use the `items` prop to provide actions/links to the disclosure dropdown. Each
+item can be either an item or a group. For `Item`s, provide an `href` string to
+make them render as links. Otherwise, they will be buttons. Provide an `action`
+function to items to be called when they are pressed, or, listen for the
+`action` event on the top-level component. Both will receive the given item as
+an argument.
 A <!-- markdownlint-disable-next-line line-length -->
 [validation error](https://gitlab.com/gitlab-org/gitlab-ui/-/blob/6cbff4f908b429cc01f17a4cc2868e881db1aa31/src/components/base/new_dropdowns/disclosure/utils.js#L1)
 will be triggered if neither field is set.
@@ -56,7 +60,7 @@ Below are the expected shapes of these objects:
 type Item = {
   text: string
   href?: string,
-  action?: function,
+  action?: (item: Item) => void,
 }
 
 type Group = {
@@ -75,15 +79,17 @@ template. If you want to render a custom template for items, use the
 
 ```html
 <gl-disclosure-dropdown :items="items">
-    <template #list-item="{ item }">
-        <a class="gl-hover-text-decoration-none gl-text-gray-900"
-           tabindex="-1"
-           :href="item.href"
-           v-bind="item.extraAttrs">
-            {{ item.text }}
-            <gl-badge pill variant="info" v-if="item.count">{{ item.count }}</gl-badge>
-        </a>
-    </template>
+  <template #list-item="{ item }">
+    <a
+      class="gl-hover-text-decoration-none gl-text-gray-900"
+      tabindex="-1"
+      :href="item.href"
+      v-bind="item.extraAttrs"
+    >
+      {{ item.text }}
+      <gl-badge v-if="item.count" pill variant="info">{{ item.count }}</gl-badge>
+    </a>
+  </template>
 </gl-disclosure-dropdown>
 ```
 

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown_item.spec.js

@@ -18,8 +18,10 @@ describe('GlDisclosureDropdownItem', () => {
   describe('when default slot content provided', () => {
     const content = 'This is an item';
     const slots = { default: content };
+    const item = mockItems[1];
+
     beforeEach(() => {
-      buildWrapper({}, slots);
+      buildWrapper({ item }, slots);
     });
 
     it('renders it', () => {
@@ -33,7 +35,7 @@ describe('GlDisclosureDropdownItem', () => {
       ${() => findItem().trigger('keydown', { code: SPACE })} | ${'SPACE'}
     `(`$event should emit 'action' event`, ({ trigger }) => {
       trigger();
-      expect(wrapper.emitted('action')).toHaveLength(1);
+      expect(wrapper.emitted('action')).toEqual([[item]]);
     });
   });
 
@@ -55,10 +57,11 @@ describe('GlDisclosureDropdownItem', () => {
   });
 
   describe('when item has an `action`', () => {
-    const action = jest.spyOn(mockItems[1], 'action');
+    const item = mockItems[1];
+    const action = jest.spyOn(item, 'action');
 
     beforeEach(() => {
-      buildWrapper({ item: mockItems[1] });
+      buildWrapper({ item });
       action.mockClear();
     });
 
@@ -69,16 +72,23 @@ describe('GlDisclosureDropdownItem', () => {
     });
 
     it('should set correct attributes', () => {
-      const attrs = { ...mockItems[1].extraAttrs };
+      const attrs = { ...item.extraAttrs };
       delete attrs.class;
-      expect(findButton().classes()).toContain(mockItems[1].extraAttrs.class);
+      expect(findButton().classes()).toContain(item.extraAttrs.class);
       expect(findButton().attributes()).toMatchObject(attrs);
     });
 
     it('should call `action` on `click`', () => {
       findButton().trigger('click');
-      expect(action).toHaveBeenCalled();
-      expect(wrapper.emitted('action')).toHaveLength(1);
+      expect(action).toHaveBeenCalledTimes(1);
+
+      const actionThisArg = action.mock.contexts[0];
+      expect(actionThisArg).toBe(undefined);
+
+      const actionArgs = action.mock.calls[0];
+      expect(actionArgs).toEqual([item]);
+
+      expect(wrapper.emitted('action')).toEqual([[item]]);
     });
 
     it.each`
@@ -88,7 +98,7 @@ describe('GlDisclosureDropdownItem', () => {
       ${() => findItem().trigger('keydown', { code: SPACE })} | ${'SPACE'}
     `(`$event will execute action and emit 'action' event`, ({ trigger }) => {
       trigger();
-      expect(wrapper.emitted('action')).toHaveLength(1);
+      expect(wrapper.emitted('action')).toEqual([[item]]);
     });
   });
 });

package/src/components/base/new_dropdowns/disclosure/disclosure_dropdown_item.vue

@@ -16,31 +16,34 @@ export default {
     },
   },
   computed: {
-    isActionItem() {
-      return this.item?.action;
+    isLink() {
+      return typeof this.item?.href === 'string';
     },
     isCustomContent() {
       return Boolean(this.$scopedSlots.default);
     },
     itemComponent() {
-      if (this.isActionItem)
+      const { item } = this;
+
+      if (this.isLink)
         return {
-          is: 'button',
+          is: 'a',
           attrs: {
-            ...this.item.extraAttrs,
-            type: 'button',
-          },
-          listeners: {
-            click: () => this.item.action(),
+            href: item.href,
+            ...item.extraAttrs,
           },
+          listeners: {},
         };
+
       return {
-        is: 'a',
+        is: 'button',
         attrs: {
-          href: this.item.href,
-          ...this.item.extraAttrs,
+          ...item.extraAttrs,
+          type: 'button',
+        },
+        listeners: {
+          click: () => item.action?.call(undefined, item),
         },
-        listeners: {},
       };
     },
   },

package/src/components/base/new_dropdowns/disclosure/utils.js

@@ -1,5 +1,4 @@
-const itemValidator = ({ text, href, action }) =>
-  Boolean(text?.length && (href?.length || typeof action === 'function'));
+const itemValidator = (item) => item?.text?.length > 0 && !Array.isArray(item?.items);
 
 const isItem = (item) => Boolean(item) && itemValidator(item);
 

package/src/components/base/new_dropdowns/disclosure/utils.spec.js

@@ -10,6 +10,7 @@ describe('isItem', () => {
   );
 
   it.each([
+    { text: 'Action' },
     { text: 'Action', href: 'gitlab.com' },
     {
       text: 'Action',

package/src/index.js

@@ -98,7 +98,6 @@ export { default as GlAccordion } from './components/base/accordion/accordion.vu
 export { default as GlAccordionItem } from './components/base/accordion/accordion_item.vue';
 export { default as GlCarousel } from './components/base/carousel/carousel.vue';
 export { default as GlCarouselSlide } from './components/base/carousel/carousel_slide.vue';
-export { default as RichTextEditor } from './components/editors/rich_text_editor/rich_text_editor.vue';
 
 // Utilities
 export { default as GlAnimatedNumber } from './components/utilities/animated_number/animated_number.vue';

package/dist/components/editors/rich_text_editor/rich_text_editor.js

@@ -1,41 +0,0 @@
-import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
-
-var script = {};
-
-/* 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('div',[_vm._v("This is a rich-text-editor")])};
-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__;

package/src/components/editors/rich_text_editor/rich_text_editor.md

@@ -1,38 +0,0 @@
-<!--
-Briefly describe the component's purpose here.
-This should correspond to the short description in Pajamas' website: https://design.gitlab.com/components/status/
--->
-
-The Rich Text Editor is a UI component that provides a WYSIWYG editing
-experience for[GitLab Flavored Markdown](https://docs.gitlab.com/ee/user/markdown.md#gitlab-flavored-markdown-gfm)
-(GFM) in the GitLab application.
-It also serves as the foundation for implementing Markdown-focused editors that target other engines,
-like static site generators.
-
-<!-- Provide technical information on how to use the component, add code examples if relevant. -->
-
-<!--
-## Dos and don'ts
-
-If relevant, describe how the component is expected to be used, and how it's not.
--->
-
-<!--
-## Browser compatibility
-
-If the component requires any polyfill or fallback on certain browsers, describe those requirements
-here.
--->
-
-<!--
-## Edge cases
-
-If the component has some known limitations, describe them here.
--->
-
-<!--
-## Deprecation warning
-
-If and when this component introduced API changes that would require deprecating old APIs, describe
-the changes here, and provide a migration paths to the new API.
--->

package/src/components/editors/rich_text_editor/rich_text_editor.spec.js

@@ -1,9 +0,0 @@
-import { shallowMount } from '@vue/test-utils';
-import GlRichTextEditor from './rich_text_editor.vue';
-
-describe('GlRichTextEditor', () => {
-  it('renders main components', () => {
-    const wrapper = shallowMount(GlRichTextEditor);
-    expect(wrapper).toBeInstanceOf(Object);
-  });
-});

package/src/components/editors/rich_text_editor/rich_text_editor.stories.js

@@ -1,25 +0,0 @@
-import readme from './rich_text_editor.md';
-import GlRichTextEditor from './rich_text_editor.vue';
-
-export default {
-  title: 'editor/Rich Text Editor',
-  component: GlRichTextEditor,
-  parameters: {
-    docs: {
-      description: {
-        component: readme,
-      },
-    },
-  },
-  argTypes: {},
-};
-
-const Template = (_, { argTypes }) => ({
-  components: { GlRichTextEditor },
-  props: Object.keys(argTypes),
-  template: `
-    <gl-rich-text-editor />
-  `,
-});
-
-export const Default = Template.bind({});

package/src/components/editors/rich_text_editor/rich_text_editor.vue

@@ -1,7 +0,0 @@
-<script>
-export default {};
-</script>
-
-<template>
-  <div>This is a rich-text-editor</div>
-</template>