4.4 KiB
title, description, framework, navigation.icon
| title | description | framework | navigation.icon |
|---|---|---|---|
| Internationalization (i18n) | Learn how to internationalize your Nuxt app with multi-directional support (LTR/RTL). | nuxt | i-lucide-languages |
::callout{to="/getting-started/i18n/vue" icon="i-logos-vue" class="hidden"} Looking for the Vue version? ::
Usage
::note{to="/components/app"} Nuxt UI provides an App component that wraps your app to provide global configurations. ::
Locale
::module-only
#ui :::div
Use the locale prop with the locale you want to use from @nuxt/ui/locale:
<script setup lang="ts">
import { fr } from '@nuxt/ui/locale'
</script>
<template>
<UApp :locale="fr">
<NuxtPage />
</UApp>
</template>
:::
#ui-pro :::div
Use the locale prop with the locale you want to use from @nuxt/ui-pro/locale:
<script setup lang="ts">
import { fr } from '@nuxt/ui-pro/locale'
</script>
<template>
<UApp :locale="fr">
<NuxtPage />
</UApp>
</template>
::: ::
Custom locale
You also have the option to add your own locale using defineLocale:
::module-only
#ui :::div
<script setup lang="ts">
import type { Messages } from '@nuxt/ui'
const locale = defineLocale<Messages>({
name: 'My custom locale',
code: 'en',
dir: 'ltr',
messages: {
// implement pairs
}
})
</script>
<template>
<UApp :locale="locale">
<NuxtPage />
</UApp>
</template>
:::
#ui-pro :::div
<script setup lang="ts">
import type { Messages } from '@nuxt/ui-pro'
const locale = defineLocale<Messages>({
name: 'My custom locale',
code: 'en',
dir: 'ltr',
messages: {
// implement pairs
}
})
</script>
<template>
<UApp :locale="locale">
<NuxtPage />
</UApp>
</template>
::: ::
::tip
Look at the code parameter, there you need to pass the iso code of the language. Example:
hiHindi (language)de-AT: German (language) as used in Austria (region)
::
Dynamic locale
To dynamically switch between languages, you can use the Nuxt I18n module.
::steps{level="4"}
Install the Nuxt I18n package
::code-group{sync="pm"}
pnpm add @nuxtjs/i18n
yarn add @nuxtjs/i18n
npm install @nuxtjs/i18n
bun add @nuxtjs/i18n
::
Add the Nuxt I18n module in your nuxt.config.ts
export default defineNuxtConfig({
modules: [
'@nuxt/ui',
'@nuxtjs/i18n'
],
css: ['~/assets/css/main.css'],
i18n: {
locales: [{
code: 'de',
name: 'Deutsch'
}, {
code: 'en',
name: 'English'
}, {
code: 'fr',
name: 'Français'
}]
}
})
Set the locale prop using useI18n
::module-only
#ui :::div
<script setup lang="ts">
import * as locales from '@nuxt/ui/locale'
const { locale } = useI18n()
</script>
<template>
<UApp :locale="locales[locale]">
<NuxtPage />
</UApp>
</template>
:::
#ui-pro :::div
<script setup lang="ts">
import * as locales from '@nuxt/ui-pro/locale'
const { locale } = useI18n()
</script>
<template>
<UApp :locale="locales[locale]">
<NuxtPage />
</UApp>
</template>
::: ::
::
Dynamic direction
Each locale has a dir property which will be used by the App component to set the directionality of all components.
In a multilingual application, you might want to set the lang and dir attributes on the <html> element dynamically based on the user's locale, which you can do with the useHead composable:
::module-only
#ui :::div
<script setup lang="ts">
import * as locales from '@nuxt/ui/locale'
const { locale } = useI18n()
const lang = computed(() => locales[locale.value].code)
const dir = computed(() => locales[locale.value].dir)
useHead({
htmlAttrs: {
lang,
dir
}
})
</script>
<template>
<UApp :locale="locales[locale]">
<NuxtPage />
</UApp>
</template>
:::
#ui-pro :::div
<script setup lang="ts">
import * as locales from '@nuxt/ui-pro/locale'
const { locale } = useI18n()
const lang = computed(() => locales[locale.value].code)
const dir = computed(() => locales[locale.value].dir)
useHead({
htmlAttrs: {
lang,
dir
}
})
</script>
<template>
<UApp :locale="locales[locale]">
<NuxtPage />
</UApp>
</template>
::: ::
Supported languages
:supported-languages