@sherby/localize

Sherby.LocalizeMixin

If you want to translate, to localize your application or simply only regroup all static texts, the Sherby.LocalizeMixin can help you.

The mixin internally use a fork of AppLocalizeBehavior to wraps the Format.js library with Chrome.i18n translation files. The Chrome.i18n format allow to add an optional description associated with the translation (message), to give an additional context to translators.

By exemple, a locales/en-CA.json file:

{
  "meat-toppings": {
    "description": "A pizza is nothing without meat.",
    "message": "Meat Toppings",
  }
}

If you want to have nested localization files, as below, you simply need to provide all keys of the nested object, separate by _ (delimiter by default). By exemple, the key meat-toppings_bacon-pieces will provide the correct translation (Bacon Pieces) for the following json file:

{
  "meat-toppings": {
    "bacon-pieces": {
      "description": "Bacon is life!",
      "message": "Bacon Pieces"
    }
  }
}

Also, as this mixin use the UdeS.LanguageMixin, the localized file associated with the current language is dynamically loaded and the localised texts are automatically translated when the current language change.

Usage

• Add the SherbyElements/sherby-localize dependency to your projet:

  bower install --save SherbyElements/sherby-localize

• Create the locales directory near the component you want localized and add the localize files:

  locales/en-CA.json

  {
    "bacon-pieces": {
      "description": "Bacon is life!",
      "message": "Bacon Pieces"
    }
  }

  locales/fr.json

  {
    "bacon-pieces": {
      "description": "Bacon is life!",
      "message": "Morceaux de bacon"
    }
  }

• Import the Sherby.LocalizeMixin inside the component you want localized:

  <link rel="import" href="../bower_components/sherby-localize/sherby-localize-mixin.html">

• Apply the mixin to your element class:

  class MyElement extends Sherby.LocalizeMixin(Polymer.Element) {
  }

• Use the localize function to translate all texts:

  • Inside the element template:

    <h2>[[localize('meat-toppings')]]</h2>

  • By JavaScript:

    getLocalizedBaconPieces(localize) {
      return localize('meat-toppings_bacon-pieces') || '';
    }

Demo

<sherby-localize-demo></sherby-localize-demo>

Language aware with UdeS.LanguageMixin

If you want your component to be aware of the current language only, you should take a look on UdeS.LanguageMixin, a mixin used by Sherby.LocalizeMixin.

Thanks

Special thanks to the Collaborne team for his app-localize-chrome-i18n-mixin mixin that inspired me for this mixin.