Globalization in ASP.NET CORE DateRangePicker Control
19 Feb 202413 minutes to read
Globalization is the combination of adapting the component to various languages by means of parsing and formatting the date or number Internationalization and also by adding cultural specific customizations and translating the text localization.
By default, DateRangePicker date format, week, and month names are specific to the American English
culture. It utilizes the Essential JavaScript 2 Internationalization package to parse and format the date object based on the culture by using the official UNICODE CLDR JSON data. It provides the loadCldr
method to load culture specific CLDR JSON data.
- Set the culture by using the locale property.
To go with the different culture other than English
, follow the below steps.
- Install the
CLDR-Data
package by using the below command (it installs the CLDR JSON data). To know more about CLDR-Data, refer the CLDR-Data link.
npm install cldr-data --save
Once the package installed, you can find the culture specific JSON data under the location /node_modules/cldr-data
.
In ASP.NET Core, the static file contents should be present under wwwroot
folder. For this, manually copy the CLDR-Data
from the node_modules
folder and place inside the wwwroot
folder and refer from the /wwwroot/scripts/cldr-data
location.
function loadCultureFiles(name) {
var files = ['ca-gregorian.json', 'numbers.json', 'timeZoneNames.json'];
var loader = ej.base.loadCldr;
var loadCulture = function (prop) {
var val, ajax;
ajax = new ej.base.Ajax(location.origin + location.pathname + '/../../scripts/cldr-data/main/' + name + '/' + files[prop], 'GET', false);
ajax.onSuccess = function (value) {
val = value;
};
ajax.send();
loader(JSON.parse(val));
};
for (var prop = 0; prop < files.length; prop++) {
loadCulture(prop);
}
}
NOTE
The
Localization
library allows to localize default text content of the DateRangePicker. The DateRangePicker component has static text for today feature that can be changed to other cultures (Arabic, Deutsch, French, etc.) by defining the locale value and translation object.
Locale keywords | Text |
---|---|
placeholder | Hint to describe expected value in input element. |
startLabel | Label to represent the start date. |
endLabel | Label to represent the end date. |
applyText | Text present in the apply button. |
cancelText | Text present in the cancel button. |
selectedDays | Text to represent selected days. |
days | Text represents days. |
customRange | Text present in the custom range button in presets container. |
- Before changing to a culture other than
English
, ensure that locale text for the concerned culture is loaded throughload
method ofL10n
class.
var L10n = ej.base.L10n;
L10n.load({
'de': {
'daterangepicker': { placeholder: 'Wählen Sie einen Bereich aus',
startLabel: 'Wählen Sie Startdatum',
endLabel: 'Wählen Sie Enddatum',
applyText: 'Sich bewerben',
cancelText: 'Stornieren',
selectedDays: 'Ausgewählte Tage',
days: 'Tage',
customRange: 'benutzerdefinierten Bereich'
}
}
});
The following example demonstrates the DateRangePicker in German
culture.
@{
ViewData["Title"] = "Home Page";
}
<ejs-daterangepicker id="daterangepicker"></ejs-daterangepicker>
<script>
document.addEventListener('DOMContentLoaded', function () {
daterangepicker = document.getElementById('daterangepicker').ej2_instances[0];
var L10n = ej.base.L10n;
L10n.load({
'de': {
'daterangepicker': {
placeholder: 'Einen Bereich auswählen',
today: 'heute'
}
}
});
loadCultureFiles('de');
daterangepicker.locale = 'de';
});
function loadCultureFiles(name) {
var files = ['ca-gregorian.json', 'numbers.json', 'timeZoneNames.json'];
if (name === 'ar') {
files.push('numberingSystems.json');
}
var loader = ej.base.loadCldr;
var loadCulture = function (prop) {
var val, ajax;
if (name === 'ar' && prop === files.length - 1) {
ajax = new ej.base.Ajax(location.origin + location.pathname + '/../../scripts/cldr-data/supplemental/' + files[prop], 'GET', false);
} else {
ajax = new ej.base.Ajax(location.origin + location.pathname + '/../../scripts/cldr-data/main/' + name + '/' + files[prop], 'GET', false);
}
ajax.onSuccess = function (value) {
val = value;
};
ajax.send();
loader(JSON.parse(val));
};
for (var prop = 0; prop < files.length; prop++) {
loadCulture(prop);
}
}
</script>
Right-To-Left
The DateRangePicker supports RTL (right-to-left) functionality for languages like Arabic and Hebrew. To display the text in the right-to-left direction, use enableRtl property.
The code example demonstrates the DateRangePicker component in Arabic
culture. It also explains how to set localized text to the placeholder using L10n.load
method.
The following example demonstrates DateRangePicker in Arabic
culture with right-to-left direction.
<ejs-daterangepicker id="daterangepicker" enableRtl=true></ejs-daterangepicker>
<script>
document.addEventListener('DOMContentLoaded', function () {
daterangepicker = document.getElementById('daterangepicker').ej2_instances[0];
var L10n = ej.base.L10n;
L10n.load({
'ar': {
'daterangepicker': {
placeholder: 'حدد نطاقا',
today: 'اليوم'
}
}
});
loadCultureFiles("ar");
daterangepicker.locale = 'ar';
});
function loadCultureFiles(name) {
var files = ['ca-gregorian.json', 'numbers.json', 'timeZoneNames.json'];
if (name === 'ar') {
files.push('numberingSystems.json');
}
var loader = ej.base.loadCldr;
var loadCulture = function (prop) {
var val, ajax;
if (name === 'ar' && prop === files.length - 1) {
ajax = new ej.base.Ajax(location.origin + location.pathname + '/../../scripts/cldr-data/supplemental/' + files[prop], 'GET', false);
} else {
ajax = new ej.base.Ajax(location.origin + location.pathname + '/../../scripts/cldr-data/main/' + name + '/' + files[prop], 'GET', false);
}
ajax.onSuccess = function (value) {
val = value;
};
ajax.send();
loader(JSON.parse(val));
};
for (var prop = 0; prop < files.length; prop++) {
loadCulture(prop);
}
}
</script>