@gitlab/ui 66.2.0 → 66.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [66.3.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v66.2.0...v66.3.0) (2023-08-30)
+
+
+### Features
+
+* accept generic translations at configuration time ([c3e04c7](https://gitlab.com/gitlab-org/gitlab-ui/commit/c3e04c7b72db211bcf3b34c9c47dc42214d1b3db))
+
 # [66.2.0](https://gitlab.com/gitlab-org/gitlab-ui/compare/v66.1.0...v66.2.0) (2023-08-30)
 
 

package/dist/charts.js

@@ -1,4 +1,3 @@
-import setConfigs from './config';
 export { default as GlChart } from './components/charts/chart/chart';
 export { default as GlAreaChart } from './components/charts/area/area';
 export { default as GlBarChart } from './components/charts/bar/bar';
@@ -13,6 +12,3 @@ export { default as GlStackedColumnChart } from './components/charts/stacked_col
 export { default as GlDiscreteScatterChart } from './components/charts/discrete_scatter/discrete_scatter';
 export { default as GlSingleStat } from './components/charts/single_stat/single_stat';
 export { default as GlSparklineChart } from './components/charts/sparkline/sparkline';
-
-// Add config files
-setConfigs();

package/dist/components/base/search_box_by_type/search_box_by_type.js

@@ -2,6 +2,7 @@ import GlClearIconButton from '../../shared_components/clear_icon_button/clear_i
 import GlFormInput from '../form/form_input/form_input';
 import GlIcon from '../icon/icon';
 import GlLoadingIcon from '../loading_icon/loading_icon';
+import { translate } from '../../../utils/i18n';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 var script = {
@@ -34,7 +35,7 @@ var script = {
     clearButtonTitle: {
       type: String,
       required: false,
-      default: 'Clear'
+      default: () => translate('GlSearchBoxByType.clearButtonTitle', 'Clear')
     },
     /**
      * If provided and true, disables the input and controls
@@ -65,7 +66,7 @@ var script = {
     inputAttributes() {
       const attributes = {
         type: 'search',
-        placeholder: 'Search',
+        placeholder: translate('GlSearchBoxByType.input.placeholder', 'Search'),
         ...this.$attrs
       };
       if (!attributes['aria-label']) {

package/dist/components/shared_components/clear_icon_button/clear_icon_button.js

@@ -1,5 +1,6 @@
 import { GlTooltipDirective } from '../../../directives/tooltip';
 import GlButton from '../../base/button/button';
+import { translate } from '../../../utils/i18n';
 import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.js';
 
 var script = {
@@ -14,7 +15,7 @@ var script = {
     title: {
       type: String,
       required: false,
-      default: 'Clear'
+      default: () => translate('ClearIconButton.title', 'Clear')
     },
     tooltipContainer: {
       required: false,

package/dist/config.js

@@ -1,5 +1,6 @@
 import { BVConfigPlugin } from 'bootstrap-vue/esm/index.js';
 import Vue from 'vue';
+import translationKeys from '../translations.json';
 import { tooltipDelay } from './utils/constants';
 
 const bFormTextGlobalConfig = {
@@ -28,11 +29,51 @@ try {
 } catch (e) {
   // localStorage doesn't exist (or the value is not properly formatted)
 }
-const setConfigs = () => {
+const i18n = translationKeys;
+let configured = false;
+
+/**
+ * Set GitLab UI configuration.
+ *
+ * @typedef {object} GitLabUIConfiguration
+ * @template TValue=string
+ * @property {undefined | Object} translations Generic translations for component labels to fall back to.
+ * @property {boolean} disableTranslations Whether translation capabilities should be disabled. Suppresses the warning about missing translations.
+ */
+const setConfigs = function () {
+  let {
+    translations
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  if (configured) {
+    if (process.env.NODE_ENV === 'development') {
+      throw new Error('GitLab UI can only be configured once!');
+    }
+    return;
+  }
+  configured = true;
   Vue.use(BVConfigPlugin, {
     BFormText: bFormTextGlobalConfig,
     BTooltip: tooltipGlobalConfig
   });
+  if (typeof translations === 'object') {
+    if (process.env.NODE_ENV === 'development') {
+      const undefinedTranslationKeys = Object.keys(i18n).reduce((acc, current) => {
+        if (!(current in translations)) {
+          acc.push(current);
+        }
+        return acc;
+      }, []);
+      if (undefinedTranslationKeys.length) {
+        /* eslint-disable no-console */
+        console.warn('[@gitlab/ui] The following translations have not been given, so will fall back to their default US English strings:');
+        console.table(undefinedTranslationKeys);
+        /* eslint-enable no-console */
+      }
+    }
+
+    Object.assign(i18n, translations);
+  }
 };
 
 export default setConfigs;
+export { i18n };

package/dist/tokens/css/tokens.css

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Wed, 30 Aug 2023 05:58:01 GMT
+ * Generated on Wed, 30 Aug 2023 06:58:09 GMT
  */
 
 :root {

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

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Wed, 30 Aug 2023 05:58:01 GMT
+ * Generated on Wed, 30 Aug 2023 06:58:09 GMT
  */
 
 :root {

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

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Wed, 30 Aug 2023 05:58:01 GMT
+ * Generated on Wed, 30 Aug 2023 06:58:09 GMT
  */
 
 export const BLACK = "#fff";

package/dist/tokens/js/tokens.js

@@ -1,6 +1,6 @@
 /**
  * Do not edit directly
- * Generated on Wed, 30 Aug 2023 05:58:01 GMT
+ * Generated on Wed, 30 Aug 2023 06:58:09 GMT
  */
 
 export const BLACK = "#000";

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

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Wed, 30 Aug 2023 05:58:01 GMT
+// Generated on Wed, 30 Aug 2023 06:58:09 GMT
 
 $red-950: #fff4f3;
 $red-900: #fcf1ef;

package/dist/tokens/scss/_tokens.scss

@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Wed, 30 Aug 2023 05:58:01 GMT
+// Generated on Wed, 30 Aug 2023 06:58:09 GMT
 
 $brand-gray-05: #2b2838 !default;
 $brand-gray-04: #45424d !default;

package/dist/utils/i18n.js

@@ -0,0 +1,15 @@
+import { i18n } from '../config';
+
+/**
+ * Mark a label as translatable.
+ *
+ * @param {string} key Translation key to be leveraged by the consumer to provide a generic translation at configuration time.
+ * @param {string} defaultValue A fallback value to be relied on if the consumer doesn't have translation capabilities.
+ * @returns {string} The translated label.
+ */
+const translate = (key, defaultValue) => {
+  var _i18n$key;
+  return (_i18n$key = i18n[key]) !== null && _i18n$key !== void 0 ? _i18n$key : defaultValue;
+};
+
+export { translate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitlab/ui",
-  "version": "66.2.0",
+  "version": "66.3.0",
   "description": "GitLab UI Components",
   "license": "MIT",
   "main": "dist/index.js",
@@ -17,7 +17,8 @@
   "files": [
     "src",
     "dist",
-    "scss_to_js"
+    "scss_to_js",
+    "translations.json"
   ],
   "scripts": {
     "build": "NODE_ENV=production rollup -c",
@@ -60,7 +61,8 @@
     "markdownlint:fix": "yarn markdownlint --fix",
     "lint": "run-p prettier eslint stylelint markdownlint",
     "lint:fix": "run-s prettier:fix eslint:fix stylelint:fix markdownlint:fix",
-    "generate:component": "plop"
+    "generate:component": "plop",
+    "translations:collect": "make translations.json"
   },
   "dependencies": {
     "@floating-ui/dom": "1.2.9",
@@ -126,7 +128,7 @@
     "eslint-import-resolver-jest": "3.0.2",
     "eslint-plugin-cypress": "2.14.0",
     "eslint-plugin-storybook": "0.6.13",
-    "glob": "^7.2.0",
+    "glob": "10.3.3",
     "identity-obj-proxy": "^3.0.0",
     "inquirer-select-directory": "^1.2.0",
     "jest": "^29.6.4",

package/src/charts.js

@@ -1,8 +1,3 @@
-// Add config files
-import setConfigs from './config';
-
-setConfigs();
-
 export { default as GlChart } from './components/charts/chart/chart.vue';
 export { default as GlAreaChart } from './components/charts/area/area.vue';
 export { default as GlBarChart } from './components/charts/bar/bar.vue';

package/src/components/base/search_box_by_type/search_box_by_type.vue

@@ -3,6 +3,7 @@ import GlClearIconButton from '../../shared_components/clear_icon_button/clear_i
 import GlFormInput from '../form/form_input/form_input.vue';
 import GlIcon from '../icon/icon.vue';
 import GlLoadingIcon from '../loading_icon/loading_icon.vue';
+import { translate } from '../../../utils/i18n';
 
 export default {
   name: 'GlSearchboxByType',
@@ -34,7 +35,7 @@ export default {
     clearButtonTitle: {
       type: String,
       required: false,
-      default: 'Clear',
+      default: () => translate('GlSearchBoxByType.clearButtonTitle', 'Clear'),
     },
     /**
      * If provided and true, disables the input and controls
@@ -66,7 +67,7 @@ export default {
     inputAttributes() {
       const attributes = {
         type: 'search',
-        placeholder: 'Search',
+        placeholder: translate('GlSearchBoxByType.input.placeholder', 'Search'),
         ...this.$attrs,
       };
 

package/src/components/shared_components/clear_icon_button/clear_icon_button.vue

@@ -1,6 +1,7 @@
 <script>
 import { GlTooltipDirective } from '../../../directives/tooltip';
 import GlButton from '../../base/button/button.vue';
+import { translate } from '../../../utils/i18n';
 
 export default {
   name: 'ClearIconButton',
@@ -14,7 +15,7 @@ export default {
     title: {
       type: String,
       required: false,
-      default: 'Clear',
+      default: () => translate('ClearIconButton.title', 'Clear'),
     },
     tooltipContainer: {
       required: false,

package/src/config.js

@@ -1,5 +1,6 @@
 import { BVConfigPlugin } from 'bootstrap-vue';
 import Vue from 'vue';
+import translationKeys from '../translations.json';
 import { tooltipDelay } from './utils/constants';
 
 const bFormTextGlobalConfig = {
@@ -31,11 +32,53 @@ try {
   // localStorage doesn't exist (or the value is not properly formatted)
 }
 
-const setConfigs = () => {
+export const i18n = translationKeys;
+
+let configured = false;
+
+/**
+ * Set GitLab UI configuration.
+ *
+ * @typedef {object} GitLabUIConfiguration
+ * @template TValue=string
+ * @property {undefined | Object} translations Generic translations for component labels to fall back to.
+ * @property {boolean} disableTranslations Whether translation capabilities should be disabled. Suppresses the warning about missing translations.
+ */
+const setConfigs = ({ translations } = {}) => {
+  if (configured) {
+    if (process.env.NODE_ENV === 'development') {
+      throw new Error('GitLab UI can only be configured once!');
+    }
+
+    return;
+  }
+  configured = true;
+
   Vue.use(BVConfigPlugin, {
     BFormText: bFormTextGlobalConfig,
     BTooltip: tooltipGlobalConfig,
   });
+
+  if (typeof translations === 'object') {
+    if (process.env.NODE_ENV === 'development') {
+      const undefinedTranslationKeys = Object.keys(i18n).reduce((acc, current) => {
+        if (!(current in translations)) {
+          acc.push(current);
+        }
+        return acc;
+      }, []);
+      if (undefinedTranslationKeys.length) {
+        /* eslint-disable no-console */
+        console.warn(
+          '[@gitlab/ui] The following translations have not been given, so will fall back to their default US English strings:'
+        );
+        console.table(undefinedTranslationKeys);
+        /* eslint-enable no-console */
+      }
+    }
+
+    Object.assign(i18n, translations);
+  }
 };
 
 export default setConfigs;

package/src/utils/i18n.js

@@ -0,0 +1,10 @@
+import { i18n } from '../config';
+
+/**
+ * Mark a label as translatable.
+ *
+ * @param {string} key Translation key to be leveraged by the consumer to provide a generic translation at configuration time.
+ * @param {string} defaultValue A fallback value to be relied on if the consumer doesn't have translation capabilities.
+ * @returns {string} The translated label.
+ */
+export const translate = (key, defaultValue) => i18n[key] ?? defaultValue;

package/translations.json

@@ -0,0 +1,5 @@
+{
+  "ClearIconButton.title": "Clear",
+  "GlSearchBoxByType.clearButtonTitle": "Clear",
+  "GlSearchBoxByType.input.placeholder": "Search"
+}