maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add Vanilla JS example to kbn-i18n README (#23556)

Browse source 
Rename Node.js to Vanilla JS and give example of internationalizing a string constant.
This commit is contained in:
CJ Cenizal 2018-09-27 07:16:52 -07:00 committed by GitHub
parent 73f955db19
commit ecaf26edd0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
packages/kbn-i18n/README.md
View file

@ -171,6 +171,37 @@ import memoizeIntlConstructor from 'intl-format-cache';
const getMessageFormat = memoizeIntlConstructor(IntlMessageFormat);
```
## Vanilla JS
`Intl-messageformat` package assumes that the
[Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl)
global object exists in the runtime. `Intl` is present in all modern
browsers and Node.js 0.10+. In order to load i18n engine
in Node.js we should simply `import` this module (in Node.js, the
[data](https://github.com/yahoo/intl-messageformat/tree/master/dist/locale-data)
for all 200+ languages is loaded along with the library) and pass the translation
messages into `init` method:
```js
import { i18n } from '@kbn/i18n';
i18n.init(messages);
```
One common use-case is that of internationalizing a string constant. Here's an
example of how we'd do that:
```js
import { i18n } from '@kbn/i18n';
export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
defaultMessage: 'Greetings, planet Earth!',
}),
```
We're also able to use all methods exposed by the i18n engine
(see [I18n engine](#i18n-engine) section above for more details).
## React
[React-intl](https://github.com/yahoo/react-intl) library is used for internalization
@ -374,26 +405,6 @@ In order to translate attributes in Angular we should use `i18nFilter`:
>
```
## Node.JS
`Intl-messageformat` package assumes that the
[Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl)
global object exists in the runtime. `Intl` is present in all modern
browsers and Node.js 0.10+. In order to load i18n engine
in Node.js we should simply `import` this module (in Node.js, the
[data](https://github.com/yahoo/intl-messageformat/tree/master/dist/locale-data)
for all 200+ languages is loaded along with the library) and pass the translation
messages into `init` method:
```js
import { i18n } from '@kbn/i18n';
i18n.init(messages);
```
After that we are able to use all methods exposed by the i18n engine
(see [I18n engine](#i18n-engine) section above for more details).
## Build tools
In order to simplify localization process, some build tools will be added: