Internationalization

Introduction

During the generation of a new project you will be asked whether or not you want to enable internationalization support.

If enabling it you will need to select the native language of your application. After that you can choose the additional languages you would like to install. If you don't want to support any additional languages from start you can always add languages later when needed by running the language sub-generator.

If you are sure you will never translate this application into another language you should not enable the internationalization.

Supported languages

These are the currently supported languages

Albanian
Arabic (Libya)
Armenian
Belarusian
Bengali
Bulgarian
Catalan
Chinese (Simplified)
Chinese (Traditional)
Czech
Danish
Dutch
English
Estonian
Farsi
Finnish
French
Galician
German
Greek
Hindi
Hungarian
Indonesian
Italian
Japanese
Korean
Marathi
Myanmar
Polish
Portuguese (Brazilian)
Portuguese
Punjabi
Romanian
Russian
Slovak
Serbian
Sinhala
Spanish
Swedish
Turkish
Tamil
Telugu
Thai
Ukrainian
Uzbek (Cyrillic)
Uzbek (Latin)
Vietnamese

Your language is missing in JHipster? Help us improve the project with a PR!

How to add languages after project generation?

To do this you can run the languages sub-generator with:

jhipster languages

Note that you will need to regenerate your entities if you would like to have them translated in the language you added right now.

How to add a new language that is not supported?

All languages are saved in the folder src/main/webapp/i18n (client side) and src/main/resources/i18n (server side)

Here are the steps to install a new language called new_lang:

Duplicate the src/main/webapp/i18/en folder to src/main/webapp/i18/new_lang (this is where all the front-end translations are stored)
Translate all files under the folder src/main/webapp/i18/new_lang
Add the language code new_lang to the languages variable defined in src/main/webapp/app/shared/language/find-language-from-key-pipe.ts

private languages: { [key: string]: { name: string; rtl?: boolean } } = {
    en: { name: 'English' },
    new_lang: { name: 'New Language' }
    // jhipster-needle-i18n-language-key-pipe - JHipster will add/remove languages in this object
};

In the src/main/resources/i18n folder, copy the messages_en.properties file to messages_new_lang.properties (this is where the server-side translations are stored)
Translate all keys in the messages_new_lang.properties file
Add the new language bundling to webpack/webpack.common.js

new MergeJsonWebpackPlugin({
    output: {
        groupBy: [
            { pattern: "./src/main/webapp/i18n/en/*.json", fileName: "./i18n/en.json" },
            { pattern: "./src/main/webapp/i18n/new_lang/*.json", fileName: "./i18n/new_lang.json" }
            // jhipster-needle-i18n-language-webpack - JHipster will add/remove languages in this array
        ]
    }
})

The new language new_lang is now available in the language menu, and it is available both in the front-end Angular application and in the back-end Spring application.

Contributing the language to generator-jhipster

If you would like to contribute a new language to the generator follow steps below;

Add the language to the LANGUAGES constant in generators/generator-constants.js

{ name: 'New Language', dispName: 'New Language', value: 'nl' }

Duplicate the file generators/languages/templates/src/main/resources/i18n/messages_en.properties.ejs to generators/languages/templates/src/main/resources/i18n/messages_nl.properties.ejs and translate all the values to the new language.
Duplicate the folder generators/languages/templates/src/main/webapp/i18n/en to generators/languages/templates/src/main/webapp/i18n/nl and translate all the files inside it.
Duplicate the file generators/entity-i18n/templates/i18n/entity_en.json.ejs to generators/entity-i18n/templates/i18n/entity_nl.json.ejs and translate all the values within it.
Duplicate the file generators/languages/templates/src/test/resources/i18n/messages_en.properties.ejs to generators/languages/templates/src/test/resources/i18n/messages_nl.properties.ejs and translate all the values within it.
Add the language value nl to the language array in test/templates/all-languages/.yo-rc.json.

Submit a PR with all these changes.

How to remove an existing language?

Here are the steps to remove a language called old_lang:

Delete the entire language folder from src/main/webapp/i18/old_lang
Remove the constant entry for LANGUAGES in src/main/webapp/app/core/language/language.constants.ts
Remove the constant entry for languages in src/main/webapp/app/shared/language/find-language-from-key.pipe.ts
Remove the constant entry for localesToKeep in webpack/webpack.prod.js
Remove the pattern for MergeJsonWebpackPlugin in webpack/webpack.common.js
Delete the src/main/resources/i18n/messages_old_lang.properties file
Delete the src/test/resources/i18n/messages_old_lang.properties file

Introduction​

Supported languages​

How to add languages after project generation?​

How to add a new language that is not supported?​

Contributing the language to generator-jhipster​

How to remove an existing language?​