@kong-ui/core-i18n
- Purpose
- Use in application
- Use in shared component
- Formatting messages
- Formatting numbers, dates and times
- Additional service functions.
Purpose
This is a wrapper around FormatJS that allows consuming application and components to have access to i18n functionality such as:
- format messages
- format numbers
- format dates
Use in application
When used in application we only need to instantiate Intl
object once, during application hydration, and then we can use it anywhere in the app via useI18n
composable.
in main.ts
(application hydration code):
import { createI18n } from '@kong-ui/core-i18n'
import english from './locales/en.json'
...
// this will create Application instance of Intl object
createI18n('en-us', english, true)
And then, anywhere in application code where i18n
is needed:
<template>
{{ i18n.t('global.ok') }}
</template>
<script setup lang="ts">
import { useI18n } from '@kong-ui/core-i18n'
const i18n = useI18n()
</script>
Use in shared component
When used in shared component (outside of application code), we need Intl
that is local to that component, so that it is using component's own localization strings:
<template>
{{ i18n.t('component.message') }}
</template>
// assuming component is receiving locale code as a property
<script setup lang="ts">
import { createI18n } from '@kong-ui/core-i18n'
import english from '../locales/en.json'
// this will instantiate `Intl` local to this component, using component's english messages.
// TODO: load and pass messages based on language passed from consuming application
const i18n = createI18n(props.locale || 'en-us', english)
</script>
Formatting messages
en.json:
{
"global": {
"ok": "Okay"
},
"test": {
"withParams": "Good {dayPart}, My name is {name}!",
"withPluralization": "{count} {count, plural, =0 {versions} =1 {version} other {versions}} available"
}
}
code:
<template>
Simple formatting:
{{ i18n.t('global.ok') }}
With parameters:
{{ i18n.t('test.withParams', { dayPart: 'Morning', name: 'i18n' }) }}
With pluralization:
{{ i18n.t('test.withPluralization', { count: 0 }) }}
{{ i18n.t('test.withPluralization', { count: 1 }) }}
{{ i18n.t('test.withPluralization', { count: 11 }) }}
</template>
<script setup lang="ts">
import { useI18n } from '@kong-ui/core-i18n'
const i18n = useI18n()
</script>
result:
Simple formatting:
Okay
With parameters:
Good Morning, My name is i18n!
With pluralization:
0 versions available
1 version available
11 version available
Where is my helpText?
In khcp-ui
there are many places where instead of using Intl function we are accessing translations string directly (from the store). Even it is not recommended way of doing thing, but because there are too many places to change, we I18n implementation is supporting this for backwards compatibility.
en.json:
{
"components": {
"docUploadCard": {
"actions": {
"edit": "Upload New",
"delete": "Delete"
}
}
}
}
code:
<template>
{{ helpText.actions.edit }}
</template>
<script setup lang="ts">
import { useI18n } from '@kong-ui/core-i18n'
const i18n = useI18n()
const helpText = i18n.source.components.docUploadCard
</script>
Please, do not use this method in any new code. This prevents using parameters/pluralization and other formatting features. use exposed methods instead.
<i18n-t>
HTML safe formatting with Sometimes it is needed to render translated message with HTML as part of the parameters. For this Provided component can be used.
en.json:
{
"global": {
"default": "See the news at {0}. There is a lot there.",
"named": "{greeting}, my name is {name}. And I am {occupation}. I want {amount}"
}
}
main.ts
(registing component)
import { createI18n, Translation } from '@kong-ui/core-i18n'
import english from './locales/en.json'
...
//this will create Application instance of Intl object
const i18n = createI18n('en-us', english, true)
// this will register <i18n-t> component
app.use(Translation, { i18n })
And then, anywhere in application code where i18n
is needed
Formatting default slot
code:
<template>
<i18n-t keypath="global.default">
<a href="https://google.com">Google</a>
</i18n-t>
</template>
result:
<span>See the news at <a href="https://google.com">Google</a>. There is a lot there.</span>
Formatting named slots. Using tag to render into template
code:
<template>
<i18n-t
tag="h1"
keypath="global.named"
>
<template #greeting>
<b>Morning</b>
</template>
<template #name>
<i>Val</i>
</template>
<template #occupation>
<i>Money Asker</i>
</template>
<template #amount>
<div class="red">{{ i18n.formatNumber(1000, { style: 'currency', currency: 'USD' }) }}</div>
</template>
</i18n-t>
</template>
result:
<h1><b>Morning</b>, my name is <i>Val</i>. And I am <i>Money Asker</i>. I want <div class="red">$1,000.00</div></h1>
Formatting numbers, dates and times
This comes for free from FormatJS, and documentation on those methods can be found there: FormatJS
Unit tests for I18n wrapper in kong-ui/core also has view examples as a references for those. FormatDate FormatNumber
Every single method listed in FormatJS is exposed and available in i18n wrapper.
Additional service functions.
(as previously exposed by vue18n-n)
te
check if translation message exists
en.json
"global": {
"ok": "Okay"
}
code:
const { te } = useI18n()
console.log({p: te('global.ok'), n: te('global.not.ok')})
console.log()
result:
{"p": true, "n": false}
tm
returns array values defined for given key
en.json
"global": {
"disabled": [
"You cannot update configurations for services",
"You cannot accept new developer portal applications",
]
}
code:
const { tm } = useI18n()
console.log(te('global.disabled'))
result:
[
"You cannot update configurations for services",
"You cannot accept new developer portal applications",
]