github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md with changes in I18n engine APIs (#47290)

Browse source
This commit is contained in:
Varun Sharma 2019-10-11 16:53:36 +01:00 • committed by Tiago Costa
parent 4de9290b98
commit 525f708f24
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -61,9 +61,9 @@ data to UI frameworks and provides methods for the direct translation.
Here is the public API exposed by this engine:
- `addMessages(messages: Map<string, string>, [locale: string])` - provides a way to register
- `addTranslation(newTranslation: Translation, [locale: string])` - provides a way to register
translations with the engine
- `getMessages()` - returns messages for the current language
- `getTranslation()` - returns messages for the current language
- `setLocale(locale: string)` - tells the engine which language to use by given
language key
- `getLocale()` - returns the current locale
@ -78,6 +78,7 @@ For the detailed explanation, see the section below
translate message by id. `description` is optional context comment that will be extracted
by i18n tools and added as a comment next to translation message at `defaultMessages.json`.
- `init(messages: Map<string, string>)` - initializes the engine
- `load(translationsUrl: string)` - loads JSON with translations from the specified URL and initializes i18n engine with them.
#### I18n engine internals