Vue Documentation
Common Features
Localization

Vue Documentation
Common Features
Localization

A newer version of this page is available.

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.

NOTE

Refer to the Using Intl and Using Globalize articles if you are localizing DevExtreme ASP.NET MVC Control.

Dictionaries

Dictionaries contain localized strings for different languages. These are JavaScript or JSON files depending on the package you use. DevExpress curates the following dictionaries:

English (en) (default)
German (de)
Japanese (ja)
Russian (ru)

There are also dictionaries that the community contributes and curates. 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 CDN or npm.

CDN or local file

Link the required dictionaries using the <script> tag.

CDN

HTML

<head>
    <!-- ... -->
    <!-- DevExtreme library -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
    <!-- Dictionary files for German and Russian languages -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.de.js"></script>
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.ru.js"></script>
</head>
<body>
    <script>
        DevExpress.localization.locale(navigator.language || navigator.browserLanguage);
        // ...
        // DevExtreme widgets are configured here
        // ...
    </script>
</body>

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:

npm: ECMAScript 6 syntax

JavaScript

// ...
// Dictionaries for German and Russian languages
import deMessages from "devextreme/localization/messages/de.json!json";
import ruMessages from "devextreme/localization/messages/ru.json!json";

// In projects created with Angular CLI 6+
// import deMessages from "devextreme/localization/messages/de.json";
// import ruMessages from "devextreme/localization/messages/ru.json";

import { locale, loadMessages } from "devextreme/localization";

loadMessages(deMessages);
loadMessages(ruMessages);
locale(navigator.language || navigator.browserLanguage)

npm: CommonJS syntax

JavaScript

// ...
// Dictionaries for German and Russian languages
const deMessages = require('devextreme/localization/messages/de.json');
const ruMessages = require('devextreme/localization/messages/ru.json');
const localization = require('devextreme/localization');

localization.loadMessages(deMessages);
localization.loadMessages(ruMessages);
localization.locale(navigator.language || navigator.browserLanguage);

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.

Localize Dates, Numbers, and Currencies

DevExtreme enables you to localize date, number and currency values using Intl or Globalize. We recommend using Intl because it is easy to activate. You can use Globalize instead if the target browser or its polyfills do not support Intl, or if your app is already using Globalize.

Using Intl

Intl is the short name used to refer to a particular ECMAScript Internationalization API object. DevExtreme supports this API via the DevExtreme-Intl module. It is available on CDN and npm, or you can save the module (JavaScript file) on your local machine.

CDN or local file

Use the <script> tag as shown in the example below to include the DevExtreme-Intl module. German and Russian dictionaries are included in this example. You can also add or replace dictionaries.

CDN

HTML

<head>
    <!-- ... -->
    <!-- DevExtreme library -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
    <!-- DevExtreme-Intl module -->
    <script src="https://unpkg.com/devextreme-intl@18.2/dist/devextreme-intl.min.js"></script>
    <!-- Dictionary files for German and Russian languages -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.de.js"></script>
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.ru.js"></script>
</head>
<body>
    <script>
        DevExpress.localization.locale(navigator.language || navigator.browserLanguage);
        // ...
        // DevExtreme widgets are configured here
        // ...
    </script>
</body>

View Demo

npm

Install the devextreme-intl package:

npm install --save-dev devextreme-intl

Then, include the devextreme-intl module using the import or require statement—the statement depends on the syntax for working with modules. The code below shows ECMAScript 6 and CommonJS syntaxes. These examples include German and Russian dictionaries.

npm: ECMAScript 6 syntax

JavaScript

// ...
import "devextreme-intl";
// Dictionaries for German and Russian languages
import deMessages from "devextreme/localization/messages/de.json!json";
import ruMessages from "devextreme/localization/messages/ru.json!json";

// In projects created with Angular CLI 6+
// import deMessages from "devextreme/localization/messages/de.json";
// import ruMessages from "devextreme/localization/messages/ru.json";

import { locale, loadMessages } from "devextreme/localization";

loadMessages(deMessages);
loadMessages(ruMessages);
locale(navigator.language || navigator.browserLanguage)

npm: CommonJS syntax

JavaScript

// ...
require("devextreme-intl");
// Dictionaries for German and Russian languages
const deMessages = require('devextreme/localization/messages/de.json');
const ruMessages = require('devextreme/localization/messages/ru.json');
const localization = require('devextreme/localization');

localization.loadMessages(deMessages);
localization.loadMessages(ruMessages);
localization.locale(navigator.language || navigator.browserLanguage);

View Demo

Strings, numbers, dates, and currencies are now automatically localized and formatted according to the specified locale. You can also specify a currency other than USD globally (using the defaultCurrency setting) or in format definitions:

jQuery

JavaScript

$(function() {
    // Specifying a currency globally
    DevExpress.config({ defaultCurrency: "EUR" });

    $("#dataGridContainer").dxDataGrid({
        // ...
        columns: [{
            dataField: "Price",
            // Specifying a currency in a format definition
            format: {
                type: "currency",
                currency: "RUB"
            }
        }]
    });
});

Angular

TypeScript

HTML

import config from "devextreme/core/config";
import { DxDataGridModule } from "devextreme-angular";
// ...
export class AppComponent {
    constructor() {
        // Specifying a currency globally
        config({ defaultCurrency: "EUR" });      
    }
}
@NgModule({
    imports: [
        // ...
        DxDataGridModule
    ],
    // ...
})

<dx-data-grid ... >
    <dxi-column dataField="price">
        <!-- Specifying a currency in a format definition -->
        <dxo-format
            type="currency"
            currency="RUB">
        </dxo-format>
    </dxi-column>
</dx-data-grid>

You can use structures compatible with the Intl API for value formatting. See an example in the DevExtreme-Intl README's API section. The Value Formatting article provides information on the extended formatting functionality DevExtreme provides out of the box.

You can use the Intl-Angular sample project as a starting point for creating new apps or as an example to copy code from when implementing specific functionality in your app.

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 and Russian dictionaries are also included. Note that the order you include the libraries is important. Then, set the locale using the Globalize.locale() method:

CDN

HTML

<head>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
    <!-- ... -->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.5.0/cldr.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.5.0/cldr/event.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/cldrjs/0.5.0/cldr/supplemental.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/globalize/1.3.0/globalize.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/globalize/1.3.0/globalize/message.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/globalize/1.3.0/globalize/number.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/globalize/1.3.0/globalize/currency.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/globalize/1.3.0/globalize/date.min.js"></script>
    <!-- DevExtreme library -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/dx.all.js"></script>
    <!-- Dictionary files for German and Russian languages -->
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.de.js"></script>
    <script src="https://cdn3.devexpress.com/jslib/18.2.18/js/localization/dx.messages.ru.js"></script>
    <!-- Common and language-specific CLDR data -->
    <script src="https://unpkg.com/devextreme-cldr-data/supplemental.js"></script>
    <script src="https://unpkg.com/devextreme-cldr-data/de.js"></script>
    <script src="https://unpkg.com/devextreme-cldr-data/ru.js"></script>
</head>
<script>
    $(function() {
        Globalize.locale(navigator.language || navigator.browserLanguage);
    });
</script>

View Demo

npm

Install the devextreme-cldr-data and globalize packages:

npm install --save-dev devextreme-cldr-data globalize

Then, include Globalize, CLDR, and language-specific CLDR data using the import or require statement—the statement depends on the syntax for working with modules. The code below shows ECMAScript 6 syntax used with a SystemJS module loader, and CommonJS syntax used with a Webpack module bundler. These examples include German and Russian dictionaries.

npm: ECMAScript 6 syntax / SystemJS configuration

JavaScript

import "devextreme/localization/globalize/number";
import "devextreme/localization/globalize/date";
import "devextreme/localization/globalize/currency";
import "devextreme/localization/globalize/message";

// Dictionaries for German and Russian languages
import deMessages from "devextreme/localization/messages/de.json!json";
import ruMessages from "devextreme/localization/messages/ru.json!json";

// Common and language-specific CLDR JSONs
import supplemental from "devextreme-cldr-data/supplemental.json!json";
import deCldrData from "devextreme-cldr-data/de.json!json";
import ruCldrData from "devextreme-cldr-data/ru.json!json";

// In projects created with Angular CLI 6+
// import deMessages from "devextreme/localization/messages/de.json";
// import ruMessages from "devextreme/localization/messages/ru.json";
// import supplemental from "devextreme-cldr-data/supplemental.json";
// import deCldrData from "devextreme-cldr-data/de.json";
// import ruCldrData from "devextreme-cldr-data/ru.json";

import Globalize from "globalize";

Globalize.load(
    supplemental, deCldrData, ruCldrData
);

Globalize.loadMessages(deMessages);
Globalize.loadMessages(ruMessages);

Globalize.locale(navigator.language || navigator.browserLanguage)

In projects created with Angular CLI 6+, register Globalize as described here. In other projects, configure config.js:

JavaScript

System.config({
    // ...
    paths: {
        "npm:": "node_modules/"
    },
    map: {
        // ...
        "globalize": "npm:globalize/dist/globalize",
        "cldr": "npm:cldrjs/dist/cldr",
        "cldr-data": "npm:cldr-data",
        "json": "npm:systemjs-plugin-json/json.js",
    },
    packages: {
        app: {
            // ...
            "globalize": {
                main: "../globalize.js",
                defaultExtension: "js"
            },
            "cldr": {
                main: "../cldr.js",
                defaultExtension: "js"
            }
        }
    }
});

npm: CommonJS syntax / Webpack configuration

JavaScript

require('devextreme/localization/globalize/message');
require('devextreme/localization/globalize/number');
require('devextreme/localization/globalize/currency');
require('devextreme/localization/globalize/date');

// Dictionaries for German and Russian languages
const deMessages = require('devextreme/localization/messages/de.json');
const ruMessages = require('devextreme/localization/messages/ru.json');

const Globalize = require('globalize');
Globalize.load(
    // Common and language-specific CLDR JSONs
    require('devextreme-cldr-data/supplemental.json'),
    require('devextreme-cldr-data/main/de.json'),
    require('devextreme-cldr-data/main/ru.json')
);

Globalize.loadMessages(deMessages);
Globalize.loadMessages(ruMessages);

Globalize.locale(navigator.language || navigator.browserLanguage);

webpack.config.js

JavaScript

module.exports = {
    // ...
    resolve: {
        alias: {
            globalize$: path.resolve( __dirname, "node_modules/globalize/dist/globalize.js" ),
            globalize: path.resolve(__dirname, "node_modules/globalize/dist/globalize"),
            cldr$: path.resolve(__dirname, "node_modules/cldrjs/dist/cldr.js"),
            cldr: path.resolve(__dirname, "node_modules/cldrjs/dist/cldr")
        }
    }
}

View Demo

Strings, numbers, dates, and currencies are now automatically localized and formatted according to the specified locale. 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:

jQuery

JavaScript

$(function() {
    $("#dataGridContainer").dxDataGrid({
        // ...
        columns: [{
            dataField: "OrderDate",
            format: { skeleton: "yMMMd" }
        }, {
            dataField: "SaleAmount",
            format: { currency: "EUR", maximumFractionDigits: 2 }
        }]
    });
});

Angular

HTML

TypeScript

<dx-data-grid ... >
    <dxi-column
        dataField="OrderDate"
        [format]="{ skeleton: 'yMMMd' }">
    </dxi-column>
    <dxi-column
        dataField="SaleAmount"
        [format]="{ currency: 'EUR', maximumFractionDigits: 2 }">
    </dxi-column>
</dx-data-grid>

import { DxDataGridModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDataGridModule
    ],
    // ...
})

Localize Custom Values

DevExtreme provides an API for localizing messages, dates, or numbers in your app.

The following example demonstrates how to localize a message. The loadMessages() method loads dictionaries for several locales. The current locale is specified using the locale() method. The formatMessage() method gets a message from the current locale's dictionary.

jQuery

JavaScript

HTML

$(function() {
    var userName = "John";
    DevExpress.localization.loadMessages({
        "en": {
            "greetingMessage": "Good morning, {0}!"
        },
        "de": {
            "greetingMessage": "Guten morgen, {0}!"
        }
    })
    DevExpress.localization.locale(navigator.language || navigator.browserLanguage);
    $("#greeting").text(
        DevExpress.localization.formatMessage("greetingMessage", userName)
    )
})

<h1 id="greeting"></h1>

Angular

TypeScript

HTML

import { formatMessage, loadMessages, locale } from "devextreme/localization";
// ...
export class AppComponent {
    constructor() {
        loadMessages({
            "en": {
                "greetingMessage": "Good morning, {0}!"
            },
            "de": {
                "greetingMessage": "Guten morgen, {0}!"
            }
        })
        locale(navigator.language || navigator.browserLanguage)
    }
    userName: string = "John";
    get greeting() {
        return formatMessage("greetingMessage", this.userName);
    }
}

<h1>{{greeting}}</h1>

To localize a custom date or number, apply a format to it as shown in the Format Custom Values article. You app should have Intl or Globalize configured.

Right-to-Left Support

Right-to-left (RTL) support allows the widget to adapt its content to right-to-left locales.

RTL layout can be specified for an individual widget using its rtlEnabled option:

jQuery

JavaScript

$(function() {
    $("#sliderContainer").dxSlider({
        // ...
        rtlEnabled: true
    });
});

Angular

HTML

TypeScript

<dx-slider ...
    [rtlEnabled]="true">
</dx-slider>

import { DxSliderModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSliderModule
    ],
    // ...
})

To apply RTL to your entire application, set the same option globally using the config() function:

jQuery

JavaScript

$(function() {
    DevExpress.config({ rtlEnabled: true });
    // ...
});

Angular

TypeScript

import config from "devextreme/core/config";
// ...
export class AppComponent {
    constructor() {
        config({ rtlEnabled: true });      
    }
}
@NgModule({
    imports: [
        // ...
        DxDataGridModule
    ],
    // ...
})

DevExtreme Vue - Localization

Dictionaries

CDN

npm: ECMAScript 6 syntax

npm: CommonJS syntax

Create a New Dictionary

Localize Dates, Numbers, and Currencies

Using Intl

CDN

npm: ECMAScript 6 syntax

npm: CommonJS syntax

jQuery

Angular

Using Globalize

CDN

npm: ECMAScript 6 syntax / SystemJS configuration

npm: CommonJS syntax / Webpack configuration

jQuery

Angular

See Also

Localize Custom Values

jQuery

Angular

Right-to-Left Support

jQuery

Angular

jQuery

Angular

See Also