DevExtreme Vue - Localization
Localization adapts your application to linguistic and regional differences. DevExtreme allows you to localize:
- Messages (using dictionaries)
- Numbers, dates, and currencies (using Intl or Globalize).
DevExtreme also supports right-to-left layout.
Dictionaries
Dictionaries contain localized strings for different languages. The strings are key/value pairs and are shipped as JavaScript or JSON files (depending on the package you use).
All dictionaries are contributed and curated by the community. The list of dictionaries is available on GitHub.
You can find all the dictionaries on your local machine in the DevExtreme installation folder's or ZIP archive's Lib\js\localization directory. These dictionaries are also available on npm.
Include the dictionaries using the import
or require
statement the statement depends on the syntax for working with modules. The following code shows ECMAScript 6 and CommonJS syntaxes:
- // ...
- // Dictionaries for German language
- import deMessages from "devextreme/localization/messages/de.json";
- import { locale, loadMessages } from "devextreme/localization";
- export default {
- created() {
- loadMessages(deMessages);
- locale(navigator.language);
- }
- }
- // ...
- // Dictionaries for German language
- const deMessages = require('devextreme/localization/messages/de.json');
- const localization = require('devextreme/localization');
- localization.loadMessages(deMessages);
- localization.locale(navigator.language);
Create a New Dictionary
To make a dictionary for a new locale:
- Copy one of the available dictionaries.
- Rename it according to the new locale.
- Translate the strings in it and change the locale key.
You can submit JSON dictionaries to our repository on GitHub. You should refer to our Contribution Guide before submitting content.
Add Strings to a Dictionary
In the following example, the loadMessages(messages) method adds a string with the greetingMessage
key to the English and German dictionaries. The formatMessage(key, value) method then uses this key to retrieve the string from the dictionary that corresponds to the locale set by the locale(locale) method.
- <template>
- <h1>{{ greeting }}</h1>
- </template>
- <script>
- import { formatMessage, loadMessages, locale } from 'devextreme/localization';
- export default {
- created() {
- loadMessages({
- 'en': {
- 'greetingMessage': 'Good morning, {0}!'
- },
- 'de': {
- 'greetingMessage': 'Guten morgen, {0}!'
- }
- });
- locale('de');
- },
- data() {
- return {
- userName: 'John'
- }
- },
- computed: {
- greeting() {
- return formatMessage('greetingMessage', this.userName);
- }
- }
- }
- </script>
You can also see this approach in one of our demos:
Override Strings in a Dictionary
To override a string, find its key in any dictionary and use it to specify the new string value.
In the following code, we override two strings from the English dictionary:
- <template>
- <!-- ... -->
- </template>
- <script>
- import { loadMessages } from 'devextreme/localization';
- export default {
- created() {
- loadMessages({
- "en": {
- "dxDataGrid-editingDeleteRow": "Remove",
- "dxDataGrid-editingUndeleteRow": "Recover"
- }
- });
- }
- }
- </script>
See Also
Using Intl
Intl is the short name used to refer to a particular ECMAScript Internationalization API object. DevExtreme supports this API out of the box. All you need to do is set the locale:
- <template>
- <!-- ... -->
- </template>
- <script>
- // Dictionaries for German language
- import deMessages from "devextreme/localization/messages/de.json";
- import { locale, loadMessages } from "devextreme/localization";
- export default {
- created() {
- loadMessages(deMessages);
- locale(navigator.language);
- }
- }
- </script>
If you want to format and localize strings, numbers, dates, and currencies automatically according to the specified locale, define the format.type property. You can also specify a currency other than USD globally. For this purpose, use the defaultCurrency or currency settings:
- <template>
- <DxDataGrid ... >
- <DxColumn data-field="price">
- <!-- Specifying a currency in a format definition -->
- <DxFormat
- type="currency"
- currency="RUB"
- />
- </DxColumn>
- </DxDataGrid>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import config from 'devextreme/core/config';
- import DxDataGrid, {
- DxColumn,
- DxFormat
- } from 'devextreme-vue/data-grid';
- export default {
- components: {
- DxDataGrid,
- DxColumn,
- DxFormat
- },
- created() {
- // Specifying a currency globally
- config({ defaultCurrency: 'EUR' });
- }
- }
- </script>
You can use structures compatible with the Intl API for value formatting. Refer to the Intl Formats section in the Value Formatting article for more information.
Using Globalize
Activating Globalize in your project requires the following files:
- Globalize library
- CLDR library
- CLDR data
All the components are available via CDN and npm.
CDN or local files
Include the Globalize and CLDR libraries using
<script>
tags as shown below. In this example, German dictionary is included. Note that the order you include the libraries is important. Then, set the locale using theGlobalize.locale()
method:npm
Install the
devextreme-cldr-data
andglobalize
packages:- npm install --save-dev devextreme-cldr-data globalize
Register Globalize in your project as described in the following help topic: Globalize Registration.
Then, include Globalize, CLDR, and language-specific CLDR data using the
import
orrequire
statement—the statement depends on the syntax for working with modules. The code below shows ECMAScript 6 and CommonJS syntaxes. These examples include German dictionary.
You can format and localize strings, numbers, dates, and currencies automatically according to a locale. For this, apply the format.type property. You can also use a currency other than USD (see the last example in the Using Intl topic).
In addition, you can now format values using structures accepted by numberFormatter, currencyFormatter, and dateFormatter, for example:
- <template>
- <DxDataGrid ... >
- <DxColumn
- data-field="OrderDate"
- :format="{ skeleton: 'yMMMd' }"
- />
- <DxColumn
- data-field="SaleAmount"
- :format="{ currency: 'EUR', maximumFractionDigits: 2 }"
- />
- </DxDataGrid>
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- // ...
- // import dictionaries and localization modules here
- import DxDataGrid, {
- DxColumn
- } from 'devextreme-vue/data-grid';
- export default {
- components: {
- DxDataGrid,
- DxColumn
- },
- // ...
- }
- </script>
See Also
Localize Custom Values
DevExtreme provides an API for localizing messages, dates, and numbers in your app.
To localize a message, add it to a dictionary as shown in the Add Strings to a Dictionary article.
To localize a custom date or number, apply a format to it as shown in the Format Custom Values article.
Right-to-Left Support
Right-to-left (RTL) support allows the UI component to adapt its content to right-to-left locales.
RTL layout can be specified for an individual UI component using its rtlEnabled property:
- <template>
- <DxSlider ...
- :rtl-enabled="true"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.light.css';
- import DxSlider from 'devextreme-vue/slider';
- export default {
- components: {
- DxSlider
- }
- }
- </script>
To apply RTL to your entire application, set the same property globally using the config() function:
- <template>
- <!-- ... -->
- </template>
- <script>
- import config from 'devextreme/core/config';
- export default {
- // ...
- created() {
- config({ rtlEnabled: true });
- }
- }
- </script>
See Also
- RTL Support Demo: DataGrid | Navigation Components | Editors
If you have technical questions, please create a support ticket in the DevExpress Support Center.