@gitlab/ui 42.14.0 → 42.15.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [42.15.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v42.14.0...v42.15.0) (2022-07-07)
+
+
+### Bug Fixes
+
+* fixed token container test ([21b3ae6](https://gitlab.com/gitlab-org/gitlab-ui/commit/21b3ae6ee8c84727726893454e012551b13c16ab))
+
+
+### Features
+
+* added clear all functionality to token selector ([fcf5200](https://gitlab.com/gitlab-org/gitlab-ui/commit/fcf52007d519ededf128eff7e264c7c7507700ca))
+
 # [42.14.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v42.13.1...v42.14.0) (2022-07-06)
 
 

package/dist/components/base/token_selector/token_container.js

@@ -1,11 +1,13 @@
 import GlToken from '../token/token';
+import GlButton from '../button/button';
 import { tokensValidator } from './helpers';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 var script = {
   name: 'GlTokenContainer',
   components: {
-    GlToken
+    GlToken,
+    GlButton
   },
   props: {
     tokens: {
@@ -27,6 +29,11 @@ var script = {
       type: Boolean,
       required: false,
       default: false
+    },
+    showClearAllButton: {
+      type: Boolean,
+      required: false,
+      default: false
     }
   },
 
@@ -147,7 +154,7 @@ var 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',{ref:"tokenContainer",staticClass:"gl-display-flex gl-flex-wrap gl-align-items-center gl-my-n1 gl-mx-n1",attrs:{"role":"listbox","aria-multiselectable":"false","aria-orientation":"horizontal","aria-invalid":_vm.state === false && 'true'},on:{"keydown":[function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"left",37,$event.key,["Left","ArrowLeft"])){ return null; }if('button' in $event && $event.button !== 0){ return null; }return _vm.handleLeftArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"right",39,$event.key,["Right","ArrowRight"])){ return null; }if('button' in $event && $event.button !== 2){ return null; }return _vm.handleRightArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"home",undefined,$event.key,undefined)){ return null; }return _vm.handleHome($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"end",undefined,$event.key,undefined)){ return null; }return _vm.handleEnd($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"delete",[8,46],$event.key,["Backspace","Delete","Del"])){ return null; }return _vm.handleDelete($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"esc",27,$event.key,["Esc","Escape"])){ return null; }return _vm.handleEscape($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"tab",9,$event.key,"Tab")){ return null; }if($event.ctrlKey||$event.shiftKey||$event.altKey||$event.metaKey){ return null; }$event.preventDefault();return _vm.handleTab($event)}]}},[_vm._l((_vm.tokens),function(token,index){return _c('div',{key:token.id,ref:"tokens",refInFor:true,staticClass:"gl-token-selector-token-container gl-px-1 gl-py-1 gl-outline-none",attrs:{"data-token-id":token.id,"role":"option","tabindex":"-1"},on:{"focus":function($event){_vm.bindFocusEvent ? _vm.handleTokenFocus(index) : null;}}},[_c('gl-token',{staticClass:"gl-cursor-default",class:token.class,style:(token.style),attrs:{"view-only":_vm.viewOnly},on:{"close":function($event){return _vm.handleClose(token)}}},[_vm._t("token-content",[_c('span',[_vm._v("\n          "+_vm._s(token.name)+"\n        ")])],{"token":token})],2)],1)}),_vm._v(" "),_vm._t("text-input")],2)};
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',{ref:"tokenContainer",staticClass:"gl-display-flex gl-flex-wrap gl-align-items-center gl-my-n1 gl-mx-n1 gl-w-full",attrs:{"role":"listbox","aria-multiselectable":"false","aria-orientation":"horizontal","aria-invalid":_vm.state === false && 'true'},on:{"keydown":[function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"left",37,$event.key,["Left","ArrowLeft"])){ return null; }if('button' in $event && $event.button !== 0){ return null; }return _vm.handleLeftArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"right",39,$event.key,["Right","ArrowRight"])){ return null; }if('button' in $event && $event.button !== 2){ return null; }return _vm.handleRightArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"home",undefined,$event.key,undefined)){ return null; }return _vm.handleHome($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"end",undefined,$event.key,undefined)){ return null; }return _vm.handleEnd($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"delete",[8,46],$event.key,["Backspace","Delete","Del"])){ return null; }return _vm.handleDelete($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"esc",27,$event.key,["Esc","Escape"])){ return null; }return _vm.handleEscape($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"tab",9,$event.key,"Tab")){ return null; }if($event.ctrlKey||$event.shiftKey||$event.altKey||$event.metaKey){ return null; }$event.preventDefault();return _vm.handleTab($event)}]}},[_vm._l((_vm.tokens),function(token,index){return _c('div',{key:token.id,ref:"tokens",refInFor:true,staticClass:"gl-token-selector-token-container gl-px-1 gl-py-1 gl-outline-none",attrs:{"data-token-id":token.id,"role":"option","tabindex":"-1"},on:{"focus":function($event){_vm.bindFocusEvent ? _vm.handleTokenFocus(index) : null;}}},[_c('gl-token',{staticClass:"gl-cursor-default",class:token.class,style:(token.style),attrs:{"view-only":_vm.viewOnly},on:{"close":function($event){return _vm.handleClose(token)}}},[_vm._t("token-content",[_c('span',[_vm._v("\n          "+_vm._s(token.name)+"\n        ")])],{"token":token})],2)],1)}),_vm._v(" "),_vm._t("text-input"),_vm._v(" "),(_vm.showClearAllButton)?_c('gl-button',{attrs:{"size":"small","aria-label":"Clear all","icon":"clear","category":"tertiary","data-testid":"clear-all-button"},on:{"click":function($event){$event.stopPropagation();return _vm.$emit('clear-all')}}}):_vm._e()],2)};
 var __vue_staticRenderFns__ = [];
 
   /* style */

package/dist/components/base/token_selector/token_selector.js

@@ -134,6 +134,15 @@ var script = {
       type: Boolean,
       required: false,
       default: false
+    },
+
+    /**
+     * Allows user to bulk delete tokens when enabled
+     */
+    allowClearAll: {
+      type: Boolean,
+      required: false,
+      default: false
     }
   },
 
@@ -189,8 +198,16 @@ var script = {
       return this.state ? 'is-valid gl-inset-border-1-gray-400!' : 'is-invalid gl-inset-border-1-red-500!';
     },
 
+    hasSelectedTokens() {
+      return this.selectedTokens.length > 0;
+    },
+
     showEmptyPlaceholder() {
-      return this.selectedTokens.length === 0 && !this.inputFocused;
+      return !this.hasSelectedTokens && !this.inputFocused;
+    },
+
+    showClearAllButton() {
+      return this.hasSelectedTokens && this.allowClearAll;
     }
 
   },
@@ -384,6 +401,11 @@ var script = {
 
     registerFocusOnToken(focusOnToken) {
       this.focusOnToken = focusOnToken;
+    },
+
+    clearAll() {
+      this.$emit('input', []);
+      this.focusTextInput();
     }
 
   }
@@ -393,7 +415,7 @@ var 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',[_c('div',{ref:"container",staticClass:"gl-token-selector gl-form-input gl-display-flex gl-align-items-center form-control form-control-plaintext gl-cursor-text! gl-py-2! gl-px-3!",class:[_vm.inputFocused ? 'gl-token-selector-focus-glow' : '', _vm.containerClass, _vm.stateClass],on:{"click":_vm.handleContainerClick}},[(_vm.showEmptyPlaceholder)?_vm._t("empty-placeholder"):_vm._e(),_vm._v(" "),_c('gl-token-container',{attrs:{"tokens":_vm.selectedTokens,"state":_vm.state,"register-focus-on-token":_vm.registerFocusOnToken,"view-only":_vm.viewOnly},on:{"token-remove":_vm.removeToken,"cancel-focus":_vm.cancelTokenFocus},scopedSlots:_vm._u([{key:"token-content",fn:function(ref){
+var __vue_render__ = function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('div',[_c('div',{ref:"container",staticClass:"gl-token-selector gl-form-input gl-display-flex gl-align-items-center form-control form-control-plaintext gl-cursor-text! gl-py-2! gl-px-3!",class:[_vm.inputFocused ? 'gl-token-selector-focus-glow' : '', _vm.containerClass, _vm.stateClass],on:{"click":_vm.handleContainerClick}},[(_vm.showEmptyPlaceholder)?_vm._t("empty-placeholder"):_vm._e(),_vm._v(" "),_c('gl-token-container',{attrs:{"tokens":_vm.selectedTokens,"state":_vm.state,"register-focus-on-token":_vm.registerFocusOnToken,"view-only":_vm.viewOnly,"show-clear-all-button":_vm.showClearAllButton},on:{"token-remove":_vm.removeToken,"cancel-focus":_vm.cancelTokenFocus,"clear-all":_vm.clearAll},scopedSlots:_vm._u([{key:"token-content",fn:function(ref){
 var token = ref.token;
 return [_vm._t("token-content",null,{"token":token})]}},{key:"text-input",fn:function(){return [_c('input',_vm._b({ref:"textInput",staticClass:"gl-token-selector-input gl-bg-none gl-font-regular gl-font-base gl-line-height-normal gl-px-1 gl-h-auto gl-text-gray-900 gl-border-none gl-outline-none gl-flex-grow-1",attrs:{"type":"text","autocomplete":_vm.autocomplete,"aria-labelledby":_vm.ariaLabelledby,"placeholder":_vm.placeholder,"disabled":_vm.viewOnly},domProps:{"value":_vm.inputText},on:{"input":function($event){_vm.inputText = $event.target.value;},"focus":_vm.handleFocus,"blur":_vm.handleBlur,"keydown":[function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"enter",13,$event.key,"Enter")){ return null; }return _vm.handleEnter($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"esc",27,$event.key,["Esc","Escape"])){ return null; }return _vm.handleEscape($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"delete",[8,46],$event.key,["Backspace","Delete","Del"])){ return null; }return _vm.handleBackspace($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"up",38,$event.key,["Up","ArrowUp"])){ return null; }$event.preventDefault();return _vm.dropdownEventHandlers.handleUpArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"down",40,$event.key,["Down","ArrowDown"])){ return null; }$event.preventDefault();return _vm.dropdownEventHandlers.handleDownArrow($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"home",undefined,$event.key,undefined)){ return null; }return _vm.dropdownEventHandlers.handleHomeKey($event)},function($event){if(!$event.type.indexOf('key')&&_vm._k($event.keyCode,"end",undefined,$event.key,undefined)){ return null; }return _vm.dropdownEventHandlers.handleEndKey($event)},function($event){$event.stopPropagation();return _vm.$emit('keydown', $event)}],"click":_vm.handleInputClick}},'input',_vm.textInputAttrs,false))]},proxy:true}],null,true)})],2),_vm._v(" "),_c('gl-token-selector-dropdown',{attrs:{"menu-class":_vm.menuClass,"show":_vm.dropdownIsOpen,"loading":_vm.loading,"dropdown-items":_vm.filteredDropdownItems,"selected-tokens":_vm.selectedTokens,"input-text":_vm.inputText,"allow-user-defined-tokens":_vm.allowUserDefinedTokens,"component-id":_vm.$options.componentId,"register-dropdown-event-handlers":_vm.registerDropdownEventHandlers,"register-reset-focused-dropdown-item":_vm.registerResetFocusedDropdownItem},on:{"dropdown-item-click":_vm.addToken,"show":_vm.openDropdown},scopedSlots:_vm._u([{key:"loading-content",fn:function(){return [_vm._t("loading-content")]},proxy:true},{key:"user-defined-token-content",fn:function(){return [_vm._t("user-defined-token-content",null,{"inputText":_vm.inputText})]},proxy:true},{key:"no-results-content",fn:function(){return [_vm._t("no-results-content")]},proxy:true},{key:"dropdown-item-content",fn:function(ref){
 var dropdownItem = ref.dropdownItem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "42.14.0",
+  "version": "42.15.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -83,7 +83,7 @@
     "@babel/preset-env": "^7.10.2",
     "@gitlab/eslint-plugin": "13.0.0",
     "@gitlab/stylelint-config": "4.1.0",
-    "@gitlab/svgs": "2.25.0",
+    "@gitlab/svgs": "2.26.0",
     "@rollup/plugin-commonjs": "^11.1.0",
     "@rollup/plugin-node-resolve": "^7.1.3",
     "@rollup/plugin-replace": "^2.3.2",

package/src/components/base/token_selector/token_container.spec.js

@@ -71,6 +71,29 @@ describe('GlTokenContainer', () => {
       });
     });
 
+    describe('clearing all tokens', () => {
+      const findClearAllButton = () => wrapper.find('[data-testid="clear-all-button"]');
+
+      it('does not render `Clear all` button by default', () => {
+        createComponent();
+
+        expect(findClearAllButton().exists()).toBe(false);
+      });
+
+      it('renders `Clear all` button when `showClearAllButton` prop is true', () => {
+        createComponent({ propsData: { showClearAllButton: true } });
+
+        expect(findClearAllButton().exists()).toBe(true);
+      });
+
+      it('emits `clear-all` event when `Clear all` button is clicked', () => {
+        createComponent({ propsData: { showClearAllButton: true } });
+        findClearAllButton().vm.$emit('click', new MouseEvent('click'));
+
+        expect(wrapper.emitted('clear-all')).toEqual([[]]);
+      });
+    });
+
     describe('state', () => {
       describe('when `state` is `false`', () => {
         it('adds `aria-invalid="true"` attribute`', () => {

package/src/components/base/token_selector/token_container.vue

@@ -1,10 +1,11 @@
 <script>
 import GlToken from '../token/token.vue';
+import GlButton from '../button/button.vue';
 import { tokensValidator } from './helpers';
 
 export default {
   name: 'GlTokenContainer',
-  components: { GlToken },
+  components: { GlToken, GlButton },
   props: {
     tokens: {
       type: Array,
@@ -26,6 +27,11 @@ export default {
       required: false,
       default: false,
     },
+    showClearAllButton: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
   },
   data() {
     return {
@@ -124,7 +130,7 @@ export default {
 <template>
   <div
     ref="tokenContainer"
-    class="gl-display-flex gl-flex-wrap gl-align-items-center gl-my-n1 gl-mx-n1"
+    class="gl-display-flex gl-flex-wrap gl-align-items-center gl-my-n1 gl-mx-n1 gl-w-full"
     role="listbox"
     aria-multiselectable="false"
     aria-orientation="horizontal"
@@ -162,5 +168,14 @@ export default {
       </gl-token>
     </div>
     <slot name="text-input"></slot>
+    <gl-button
+      v-if="showClearAllButton"
+      size="small"
+      aria-label="Clear all"
+      icon="clear"
+      category="tertiary"
+      data-testid="clear-all-button"
+      @click.stop="$emit('clear-all')"
+    />
   </div>
 </template>

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

@@ -86,6 +86,8 @@ describe('GlTokenSelector', () => {
 
   const findContainer = () => wrapper.findComponent({ ref: 'container' });
 
+  const findTokenContainer = () => wrapper.findComponent(GlTokenContainer);
+
   beforeAll(() => {
     if (!HTMLElement.prototype.scrollIntoView) {
       HTMLElement.prototype.scrollIntoView = jest.fn();
@@ -149,7 +151,7 @@ describe('GlTokenSelector', () => {
       });
 
       it('passes `viewOnly` prop to GlTokenContainer', () => {
-        expect(wrapper.findComponent(GlTokenContainer).props('viewOnly')).toBe(true);
+        expect(findTokenContainer().props('viewOnly')).toBe(true);
       });
 
       it('disables input field if viewOnly is true', () => {
@@ -159,6 +161,16 @@ describe('GlTokenSelector', () => {
       });
     });
 
+    describe('when there are tokens and `allowClearAll` is true', () => {
+      beforeEach(() => {
+        createComponent({ propsData: { allowClearAll: true, selectedTokens: tokens } });
+      });
+
+      it('passes `showClearAllButton` prop as `true` to token-container', () => {
+        expect(findTokenContainer().props('showClearAllButton')).toBe(true);
+      });
+    });
+
     describe('containerClass', () => {
       it('renders passed CSS classes', () => {
         createComponent({
@@ -290,7 +302,7 @@ describe('GlTokenSelector', () => {
         },
       });
 
-      expect(wrapper.findComponent(GlTokenContainer).props('state')).toBe(true);
+      expect(findTokenContainer().props('state')).toBe(true);
     });
   });
 
@@ -589,7 +601,7 @@ describe('GlTokenSelector', () => {
         propsData: { selectedTokens: [token] },
       });
 
-      wrapper.findComponent(GlTokenContainer).vm.$emit('token-remove', token);
+      findTokenContainer().vm.$emit('token-remove', token);
 
       await nextTick();
     });
@@ -631,7 +643,7 @@ describe('GlTokenSelector', () => {
         selectedTokens: tokens,
       });
 
-      wrapper.findComponent(GlTokenContainer).vm.$emit('cancel-focus');
+      findTokenContainer().vm.$emit('cancel-focus');
 
       await nextTick();
 

package/src/components/base/token_selector/token_selector.vue

@@ -1,6 +1,5 @@
 <script>
 import { uniqueId } from 'lodash';
-
 import { tokensValidator } from './helpers';
 import GlTokenContainer from './token_container.vue';
 import GlTokenSelectorDropdown from './token_selector_dropdown.vue';
@@ -8,7 +7,10 @@ import GlTokenSelectorDropdown from './token_selector_dropdown.vue';
 export default {
   name: 'GlTokenSelector',
   componentId: uniqueId('token-selector'),
-  components: { GlTokenContainer, GlTokenSelectorDropdown },
+  components: {
+    GlTokenContainer,
+    GlTokenSelectorDropdown,
+  },
   model: {
     prop: 'selectedTokens',
     event: 'input',
@@ -121,6 +123,14 @@ export default {
       required: false,
       default: false,
     },
+    /**
+     * Allows user to bulk delete tokens when enabled
+     */
+    allowClearAll: {
+      type: Boolean,
+      required: false,
+      default: false,
+    },
   },
   data() {
     return {
@@ -173,8 +183,14 @@ export default {
         ? 'is-valid gl-inset-border-1-gray-400!'
         : 'is-invalid gl-inset-border-1-red-500!';
     },
+    hasSelectedTokens() {
+      return this.selectedTokens.length > 0;
+    },
     showEmptyPlaceholder() {
-      return this.selectedTokens.length === 0 && !this.inputFocused;
+      return !this.hasSelectedTokens && !this.inputFocused;
+    },
+    showClearAllButton() {
+      return this.hasSelectedTokens && this.allowClearAll;
     },
   },
   watch: {
@@ -357,6 +373,10 @@ export default {
     registerFocusOnToken(focusOnToken) {
       this.focusOnToken = focusOnToken;
     },
+    clearAll() {
+      this.$emit('input', []);
+      this.focusTextInput();
+    },
   },
 };
 </script>
@@ -377,8 +397,10 @@ export default {
         :state="state"
         :register-focus-on-token="registerFocusOnToken"
         :view-only="viewOnly"
+        :show-clear-all-button="showClearAllButton"
         @token-remove="removeToken"
         @cancel-focus="cancelTokenFocus"
+        @clear-all="clearAll"
       >
         <template #token-content="{ token }">
           <!-- @slot Content to pass to the token component slot. Can be used