@gitlab/ui 72.8.1 → 72.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "72.8.1",
+  "version": "72.10.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -17,13 +17,15 @@
   "files": [
     "src",
     "dist",
-    "translations.json"
+    "translations.json",
+    "tailwind.defaults.js"
   ],
   "scripts": {
     "build": "NODE_ENV=production rollup -c",
     "prebuild": "run-s build-tokens generate-utilities",
     "prepare": "run-s build-tokens generate-utilities",
     "generate-utilities": "make src/scss/utilities.scss",
+    "deprecate-gl-utils": "./bin/deprecate_utils.js",
     "copy-fonts": "make copy-fonts",
     "build-tokens": "node ./bin/build_tokens.js",
     "clean": "rm -r dist storybook src/scss/utilities.scss",
@@ -61,7 +63,8 @@
     "lint": "run-p prettier eslint stylelint markdownlint",
     "lint:fix": "run-s prettier:fix eslint:fix stylelint:fix markdownlint:fix",
     "generate:component": "plop",
-    "translations:collect": "make translations.json"
+    "translations:collect": "make translations.json",
+    "tailwind-config-viewer": "tailwind-config-viewer -o"
   },
   "dependencies": {
     "@floating-ui/dom": "1.4.3",
@@ -78,6 +81,7 @@
     "dompurify": "^2.4.7 || ^3.0.5",
     "emoji-regex": ">=10.0.0",
     "pikaday": "^1.8.0",
+    "tailwindcss": "3^",
     "vue": "^2.7.16"
   },
   "resolutions": {
@@ -154,7 +158,7 @@
     "react-dom": "^18.2.0",
     "rollup": "^2.53.1",
     "rollup-plugin-babel": "^4.4.0",
-    "rollup-plugin-postcss": "^3.1.1",
+    "rollup-plugin-postcss": "4.0.2",
     "rollup-plugin-string": "^3.0.0",
     "rollup-plugin-svg": "^2.0.0",
     "rollup-plugin-vue": "^5.1.6",
@@ -167,6 +171,8 @@
     "storybook-dark-mode": "3.0.3",
     "style-dictionary": "^3.8.0",
     "stylelint": "15.10.2",
+    "tailwind-config-viewer": "1.7.3",
+    "tailwindcss": "3.4.1",
     "vue": "2.7.16",
     "vue-loader": "^15.8.3",
     "vue-loader-vue3": "npm:vue-loader@17",

package/src/components/base/new_dropdowns/listbox/listbox.md

@@ -134,7 +134,8 @@ To update content of the listbox, toggle the `searching` property
 and update the `items` property with a new array. Be sure to debounce (or
 similar) the `search` event handler to avoid rendering stale results.
 To improve the accessibility, provide the `search-summary-sr-only` scoped slot
-with a number of found search results text.
+with a number of found search results text, alternately, you can pass a plural translate function.
+An example of the plural translate function can be found [the GitLab Docs internationalization section](https://docs.gitlab.com/ee/development/i18n/externalization.html#plurals)
 Screen reader will announce this text when the list is updated.
 
 ```html

package/src/components/base/new_dropdowns/listbox/listbox.spec.js

@@ -477,6 +477,11 @@ describe('GlCollapsibleListbox', () => {
     });
 
     describe('Screen reader text with number of search results', () => {
+      it('when the #search-summary-sr-only slot content is empty', () => {
+        buildWrapper({ items: mockOptions, searchable: true, searching: false });
+        expect(findSRNumberOfResultsText().text()).toBe('12 results');
+      });
+
       it('when the #search-summary-sr-only slot content is provided', () => {
         const searchResultsContent = 'Found 5 results';
         const slots = { 'search-summary-sr-only': searchResultsContent };

package/src/components/base/new_dropdowns/listbox/listbox.stories.js

@@ -60,6 +60,7 @@ const generateProps = ({
   startOpened = true,
   fluidWidth,
   positioningStrategy,
+  srOnlyResultsLabel,
 } = {}) => ({
   items,
   category,
@@ -90,6 +91,7 @@ const generateProps = ({
   startOpened,
   fluidWidth,
   positioningStrategy,
+  srOnlyResultsLabel,
 });
 
 const makeBindings = (overrides = {}) =>
@@ -123,6 +125,7 @@ const makeBindings = (overrides = {}) =>
     ':fluid-width': 'fluidWidth',
     ':positioning-strategy': 'positioningStrategy',
     ':startOpened': 'startOpened',
+    ':sr-only-results-label': 'srOnlyResultsLabel',
     ...overrides,
   })
     .map(([key, value]) => `${key}="${value}"`)
@@ -577,6 +580,11 @@ export default {
         subcategory: ARG_TYPE_SUBCATEGORY_ACCESSIBILITY,
       },
     },
+    srOnlyResultsLabel: {
+      table: {
+        subcategory: ARG_TYPE_SUBCATEGORY_ACCESSIBILITY,
+      },
+    },
     listAriaLabelledBy: {
       table: {
         subcategory: ARG_TYPE_SUBCATEGORY_ACCESSIBILITY,
@@ -644,7 +652,7 @@ export const Searchable = (args, { argTypes }) => ({
       return toggleText;
     },
     numberOfSearchResults() {
-      return this.filteredItems.length === 1 ? '1 result' : `${this.filteredItems.length} results`;
+      return `${this.filteredItems.length} department${this.filteredItems.length > 1 ? 's' : ''}`;
     },
   },
   template: template(
@@ -700,11 +708,6 @@ export const SearchableGroups = (args, { argTypes }) => ({
 
       return toggleText;
     },
-    numberOfSearchResults() {
-      return this.flattenedFilteredOptions.length === 1
-        ? '1 result'
-        : `${this.flattenedFilteredOptions.length} results`;
-    },
   },
   methods: {
     filterList(searchTerm) {
@@ -729,20 +732,19 @@ export const SearchableGroups = (args, { argTypes }) => ({
         this.searchInProgress = false;
       }, 2000);
     },
+    srOnlyResultsLabel(count) {
+      return `${count} branch${count > 1 ? 'es' : ''} or tag${count > 1 ? 's' : ''}`;
+    },
   },
-  template: template(
-    `<template #search-summary-sr-only>
-      {{ numberOfSearchResults }}
-    </template>`,
-    {
-      bindingOverrides: {
-        ':items': 'filteredGroupOptions',
-        ':toggle-text': 'customToggleText',
-        ':searching': 'searchInProgress',
-        '@search': 'filterList',
-      },
-    }
-  ),
+  template: template('', {
+    bindingOverrides: {
+      ':items': 'filteredGroupOptions',
+      ':toggle-text': 'customToggleText',
+      ':searching': 'searchInProgress',
+      ':sr-only-results-label': 'srOnlyResultsLabel',
+      '@search': 'filterList',
+    },
+  }),
 });
 SearchableGroups.args = generateProps({
   headerText: 'Select ref',

package/src/components/base/new_dropdowns/listbox/listbox.vue

@@ -26,6 +26,7 @@ import GlLoadingIcon from '../../loading_icon/loading_icon.vue';
 import GlIntersectionObserver from '../../../utilities/intersection_observer/intersection_observer.vue';
 import GlSearchBoxByType from '../../search_box_by_type/search_box_by_type.vue';
 import GlBaseDropdown from '../base_dropdown/base_dropdown.vue';
+import { translate } from '../../../../utils/i18n';
 import GlListboxItem from './listbox_item.vue';
 import GlListboxSearchInput from './listbox_search_input.vue';
 import GlListboxGroup from './listbox_group.vue';
@@ -339,6 +340,17 @@ export default {
       required: false,
       default: false,
     },
+    srOnlyResultsLabel: {
+      type: Function,
+      required: false,
+      default: (count) => {
+        const fn = translate('GlCollapsibleListbox.srOnlyResultsLabel', 'Results count');
+        if (typeof fn === 'function') {
+          return fn(count);
+        }
+        return `${count} result${count > 1 ? 's' : ''}`;
+      },
+    },
   },
   data() {
     return {
@@ -394,9 +406,7 @@ export default {
       return !this.flattenedOptions.length && !this.searching;
     },
     announceSRSearchResults() {
-      return (
-        this.searchable && !this.showNoResultsText && this.$scopedSlots['search-summary-sr-only']
-      );
+      return this.searchable && !this.showNoResultsText;
     },
     headerId() {
       return this.headerText && uniqueId('listbox-header-');
@@ -912,7 +922,9 @@ export default {
       aria-live="assertive"
     >
       <!-- @slot Text read by screen reader announcing a number of search results -->
-      <slot name="search-summary-sr-only"></slot>
+      <slot name="search-summary-sr-only">
+        {{ srOnlyResultsLabel(flattenedOptions.length) }}
+      </slot>
     </span>
 
     <div

package/src/scss/storybook.scss

@@ -1,4 +1,7 @@
 @import 'tokens';
+
+@tailwind utilities;
+
 @import 'functions';
 @import 'variables';
 

package/src/scss/utilities.scss

@@ -6510,6 +6510,16 @@ $gl-animate-skeleton-loader-max-width: 64 * $grid-size;
 .gl-mr-auto\! {
   margin-right: auto !important;
 }
+.gl-md-mr-auto {
+  @include gl-media-breakpoint-up(md) {
+  margin-right: auto;
+  }
+}
+.gl-md-mr-auto\! {
+  @include gl-media-breakpoint-up(md) {
+  margin-right: auto !important;
+  }
+}
 .gl-mr-0 {
   margin-right: 0;
 }

package/src/scss/utility-mixins/spacing.scss

@@ -473,6 +473,12 @@
   margin-right: auto;
 }
 
+@mixin gl-md-mr-auto {
+  @include gl-media-breakpoint-up(md) {
+    @include gl-mr-auto;
+  }
+}
+
 @mixin gl-mr-0 {
   margin-right: 0;
 }

package/tailwind.defaults.js

@@ -0,0 +1,5 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+  prefix: 'gl-',
+  corePlugins: [],
+};

package/translations.json

@@ -3,5 +3,6 @@
   "GlSorting.sortAscending": "Sort direction: ascending",
   "GlSorting.sortDescending": "Sort direction: descending",
   "GlSearchBoxByType.clearButtonTitle": "Clear",
-  "GlSearchBoxByType.input.placeholder": "Search"
+  "GlSearchBoxByType.input.placeholder": "Search",
+  "GlCollapsibleListbox.srOnlyResultsLabel": "Results count"
 }