Date and Time Pickers - Localization
Date and Time Pickers support translations between languages.
As with all MUI components, you can modify text and translations inside the Date and Time Pickers. You can find all the translation keys supported in the source in the GitHub repository.
The default locale of MUI is English (United States). If you want to use other locales, follow the instructions below.
Set translations globally
Using the theme
To translate all your components from @mui/x-date-pickers
and @mui/x-date-pickers-pro
,
you just have to import the locale from @mui/x-date-pikers
(see the list of supported locales below).
import { createTheme, ThemeProvider } from '@mui/material/styles';
import { deDE } from '@mui/x-date-pickers';
const theme = createTheme(
{
palette: {
primary: { main: '#1976d2' },
},
},
deDE, // use 'de' locale for UI texts (start, next month, ...)
);
function App({ children }) {
return <ThemeProvider theme={theme}>{children}</ThemeProvider>;
}
Note that createTheme
accepts any number of arguments.
If you are already using the translations of the core components or the translations of the data grid, you can add deDE
as a new argument.
import { createTheme, ThemeProvider } from '@mui/material/styles';
import { deDE as dataGridDeDE } from '@mui/x-data-grid';
import { deDE as coreDeDE } from '@mui/material/locale';
import { deDE } from '@mui/x-date-pickers';
const theme = createTheme(
{
palette: {
primary: { main: '#1976d2' },
},
},
deDE, // x-date-pickers translations
dataGridDeDE, // x-data-grid translations
coreDeDE, // core translations
);
function App({ children }) {
return <ThemeProvider theme={theme}>{children}</ThemeProvider>;
}
Using LocalizationProvider
If you want to pass language translations without using createTheme
and ThemeProvider
,
you can directly load the language translations from the @mui/x-date-pickers
or @mui/x-date-pickers-pro
package and pass them to the LocalizationProvider
.
import { LocalizationProvider, deDE, DatePicker } from '@mui/x-date-pickers';
<LocalizationProvider
localeText={deDE.components.MuiLocalizationProvider.defaultProps.localeText}
>
<DatePicker />
</LocalizationProvider>;
Set translations locally
You can also customize the translations of a single component.
If you want to customize some translations on specific component, you can use the localeText
prop exposed by all our pickers.
<DatePicker localeText={{ clearButtonLabel: 'Empty' }} />
Supported locales
Locale | BCP 47 language tag | Import name | Completion | Related file |
---|---|---|---|---|
Chinese (Simplified) | zh-CN | zhCN | 19/35 | Edit |
Dutch | nl-NL | nlNL | 19/35 | Edit |
Finnish | fi-FI | fiFI | 24/35 | Edit |
French | fr-FR | frFR | 20/35 | Edit |
German | de-DE | deDE | 31/35 | Edit |
Icelandic | is-IS | isIS | 24/35 | Edit |
Italian | it-IT | itIT | 19/35 | Edit |
Japanese | ja-JP | jaJP | 24/35 | Edit |
Korean | ko-KR | koKR | 35/35 | Edit |
Norwegian (bokmål) | nb-NO | nbNO | 19/35 | Edit |
Persian | fa-IR | faIR | 24/35 | Edit |
Polish | pl-PL | plPL | 19/35 | Edit |
Portuguese (Brazil) | pt-BR | ptBR | 19/35 | Edit |
Spanish | es-ES | esES | 19/35 | Edit |
Swedish | sv-SE | svSE | 19/35 | Edit |
Turkish | tr-TR | trTR | 31/35 | Edit |
Ukrainian | uk-UA | ukUA | 35/35 | Edit |
Urdu (Pakistan) | ur-PK | urPK | 28/35 | Edit |
You can find the source in the GitHub repository.
To create your own translation or to customize the English text, copy this file to your project, make any changes needed and import the locale from there. Note that these translations of the date and time picker components depend on the Localization strategy of the whole library.