docs: Update Parameter for VueI18n Translation Function Parameter #2850
Conversation
## Background
Since the structure of `locale/<anything>.json` is
```json
{
"code": "en",
"messages": {
"required": "The {_field_} field is required"
}
}
```
and instantiate VueI18n this way
```javascript
const i18n = new VueI18n({
locale: 'en',
en: {
validations: validationMessages
}
});
```
I think the correct parameter for translation function is `$t('validations.messages.required', values)`
Codecov Report
@@ Coverage Diff @@
## master #2850 +/- ##
=======================================
Coverage 95.67% 95.67%
=======================================
Files 50 50
Lines 1319 1319
Branches 317 317
=======================================
Hits 1262 1262
Misses 57 57 Continue to review full report at Codecov.
|
|
The example shows how to do so for any rule because the |
Based on https://kazupon.github.io/vue-i18n/guide/component.html#component-based-localization the structure of VueI18n constructor options parameter for declaring translations should be like this ``` { locale: 'en', messages: { en: {} } } ```
|
The code in the example is incorrect. I've created simple reproduction for that here, VeeValidate Docs Correct Example. Please take a look on Using the following code (changes) configure({
defaultMessage: (field, values) =>
this.$t(`validations.messages.${values._rule_}`, values)
});The result will be correct
But using the following code (existing example) configure({
defaultMessage: (field, values) =>
this.$t(`validations.${values._rule_}`, values)
});The result will be incorrect
UpdatesI also have updated the code example for VueI18n constructor parameter options. According to the following docs VueI18n: Component Based Localization the correct parameter options is: {
locale: 'en',
messages: {
en: {
validations: validationMessages
}
}
}not: {
locale: 'en',
en: {
validations: validationMessages
}
}The reproduction for this update also can be take a look on the VeeValidate Docs Correct Example above. |
🔎 Overview
Background
Since the structure of
locale/<anything>.jsonis{ "code": "en", "messages": { "required": "The {_field_} field is required" } }and on the example we instantiate VueI18n this way
I think the correct parameter for translation function is
$t('validations.messages.required', values)✔ Issues affected
Nothing