methods/i18n.js

  1. import { DEFAULT_LANG } from './../lib/constants'
  2. import _config from './../lib/config'
  4. /**
  5.  * @method
  6.  * @memberof ecomUtils
  7.  * @name i18n
  8.  * @description Get translated string by lang code from dictionary object.
  9.  * @param {object} dictionary - Dictionary object containing string in multiple langs
  10.  * @param {string} [lang=$ecomConfig.get('lang')] - Snake case language code, eg.: 'en_us', 'pt_br'
  11.  * @returns {string|object}
  12.  *
  13.  * @example
  14.  * // With simple dictionary objects
  15.  * ecomUtils.i18n({ en_us: 'Hello', pt_br: 'Olá' })
  16.  * // => 'Hello'
  17.  * ecomUtils.i18n({ en_us: 'Hello', pt_br: 'Olá' }, 'pt_br')
  18.  * // => 'Olá'
  19.  *
  20.  * @example
  21.  * // With nested objects
  22.  * ecomUtils.i18n({ hello: { en_us: 'Hello', pt_br: 'Olá' }})
  23.  * // => { hello: 'Hello' }
  24.  * ecomUtils.i18n({ hello: { en_us: 'Hello', pt_br: 'Olá' }, world: { en_us: 'World' }}, 'pt_br')
  25.  * // => { hello: 'Olá', world: 'World' }
  26.  * ecomUtils.i18n({ en_us: { hello: 'Hello', world: 'World' }, pt_br: { hello: 'Olá' }}, 'pt_br')
  27.  * // => { hello: 'Olá' }
  28.  *
  29.  * @example
  30.  * // You can also set the configured lang first
  31.  * $ecomConfig.set('lang', 'pt_br')
  32.  * // Then call `i18n` without expliciting lang
  33.  * ecomUtils.i18n({ en_us: 'Hello', pt_br: 'Olá' })
  34.  * // => Olá
  35.  */
  36. const i18n = (dictionary, lang = _config.get('lang')) => {
  37.   if (typeof dictionary === 'object' && dictionary !== null) {
  38.     const prop = Object.keys(dictionary)[0]
  39.     if (/^[a-z]{2}(_[a-z]{2})?$/.test(prop)) {
  40.       // supposed to be object of languages options
  41.       return dictionary[lang] || dictionary[DEFAULT_LANG] || dictionary[prop]
  42.     } else {
  43.       // recursive
  44.       const localDictionary = Array.isArray(dictionary) ? [] : {}
  45.       for (const prop in dictionary) {
  46.         if (dictionary[prop] !== undefined) {
  47.           localDictionary[prop] = i18n(dictionary[prop], lang)
  48.         }
  49.       }
  50.       return localDictionary
  51.     }
  52.   }
  53.   return dictionary
  54. }
  56. export default i18n