@teages/nuxt-locale-lite

Use minimal configuration to setup i18n for your Nuxt app.

Features

• 🚀 Minimal config, add multi-language support in just three minutes
• 🪶 Build-in (and force) lazy-load support

Used by Cytoid/cytoid.io.

Quick Setup

1. Add @teages/nuxt-locale-lite dependency to your project

# Using pnpm
pnpm add -D @teages/nuxt-locale-lite

# Using yarn
yarn add --dev @teages/nuxt-locale-lite

# Using npm
npm install --save-dev @teages/nuxt-locale-lite

2. Add @teages/nuxt-locale-lite to the modules section of nuxt.config.ts, and configure it:

export default defineNuxtConfig({
  modules: [
    '@teages/nuxt-locale-lite'
  ],

  locale: {
    lang: {
      'en-US': { name: 'English' },
      'zh-CN': { name: '中文（简体）' },
      'ja-JP': { name: '日本語' },
    },
  },
})

3. Setup VSCode

You need to install i18n-ally.

Add these config to your settings.json:

{
  "i18n-ally.localesPaths": [
    "locales" // or any other path you configured
  ],
  "i18n-ally.keystyle": "nested",
  "i18n-ally.pathMatcher": "{locale}/{namespaces}.json",
  "i18n-ally.namespace": true,
  "i18n-ally.sourceLanguage": "en-US" // or your default locale
}

That's it! ✨

How to use

Add locale files

This module will automatically load the locale files under the locales (or path you configured) directory.

For example, we have the following directory structure:

locales
├── en-US
│   ├── another.json
│   └── general.json
├── zh-CN
│   ├── another.json
│   └── general.json
└── ja-JP
    ├── another.json
    └── general.json

in locales/en-US/general.json:

{
  "hello": "Hello world!",
  "deep": {
    "hello": "Hello the deep world!"
  }
}

Get locale messages

Then you can use the following code to get the locale messages:

<script setup>
const { t } = useLocales()
console.log(t('general.hello')) // Hello world!
</script>

<template>
  <div>
    {{ $t('general.deep.hello') }} <!-- Hello the deep world! -->
  </div>
</template>

Change locale

You can use the following code to change the locale:

const { locale, setLocale } = useLocales()
console.log(locale.value) // en-US
setLocale('zh-CN')
console.log(locale.value) // zh-CN

// or
locale.value = 'ja-JP'

Development

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint