Internationalization and Localization

The Locale API allows setting i18n and l7n options globally for the components.

Getting Started

By using the locale, addLocale, updateLocaleOption, updateLocaleOptions, localeOption and localeOptions methods, locale objects can be used in the whole application or in certain pages.

import { locale, addLocale, updateLocaleOption, updateLocaleOptions, localeOption, localeOptions } from 'primereact/api';
 

The current locale can be set with locale method.

locale('en');
 

New locale values can be added using addLocale method for the application.

addLocale('es', {
    firstDayOfWeek: 1,
    dayNames: ['domingo', 'lunes', 'martes', 'miércoles', 'jueves', 'viernes', 'sábado'],
    dayNamesShort: ['dom', 'lun', 'mar', 'mié', 'jue', 'vie', 'sáb'],
    dayNamesMin: ['D', 'L', 'M', 'X', 'J', 'V', 'S'],
    monthNames: ['enero', 'febrero', 'marzo', 'abril', 'mayo', 'junio', 'julio', 'agosto', 'septiembre', 'octubre', 'noviembre', 'diciembre'],
    monthNamesShort: ['ene', 'feb', 'mar', 'abr', 'may', 'jun', 'jul', 'ago', 'sep', 'oct', 'nov', 'dic'],
    today: 'Hoy',
    clear: 'Limpiar'
});

locale('es');
 

Locale values can be changed dynamically. (Note: please don't forget to update main or current component with state management or forceUpdate method of React.)

<Button label="EN" onClick={() => locale('en')} />
<Button label="ES" onClick={() => locale('es')} />
 

Locale Repo

Ready to use settings for locales are available at the community supported PrimeLocale repository. We'd appreciate if you could contribute to this repository with pull requests and share it with the rest of the community.

Locale Methods

Locale Options