mirai-audio / ember-i18n-changeset-validations

ember-i18n support for ember-changeset-validations messages
MIT License
10 stars 1 forks source link
ember ember-addon ember-changeset i18n internationalization validation

ember-i18n-changeset-validations

CircleCI Coveralls branch npm Ember Ember Observer Score Greenkeeper badge

Adds support for ember-i18n to ember-changeset-validations

ember-i18n-changeset-validations is a companion validation library to ember-changeset-validations. This addon adds the ability to translate ember-changeset-validation messages using the ember-i18n addon. Since ember-changeset is required to use this addon, please see documentation there on how to use changeset.

Usage

To install: ember install ember-i18n-changeset-validations.

This addon also provides ember-changeset-validations (and ember-changeset) as dependencies.

Define ember-i18n translation files for the validation messages files in app/locales/<LANG_CODE>/validations.js (where LANG_CODE is an ISO language code).

An example of an ember-i18n translation file, showing a translation key that will replace the default "between" message from ember-changeset-validations.

// app/locales/en/validations.js
export default {
  /* overrides for ember-changeset-validation messages
   * see: ember-changeset-validations/utils/messages
   */
  between: "{description} must be between{min} and {max} characters",
};

An example of a Japanese validation message.

// app/locales/ja/validations.js
export default {
  /* overrides for ember-changeset-validation messages
   * see: ember-changeset-validations/utils/messages
   */
  between: "{description}は{min}〜{max}文字の間でなければなりません",
};

For each locale (en & ja in this example), import the validations translation module into the main ember-i18n manifest, located in app/locales/<LANG_CODE>/translations.js.

e.g English translations manifest file.

// app/locales/en/validations.js
import validations from "./validations";
// other imports

export default {
  // other translation objects
  validations
};

e.g. Japanese translations manifest file.

// app/locales/ja/validations.js
import validations from "./validations";
// other imports

export default {
  // other translation objects
  validations
};

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.