alisobirjanov/i18n-kit

🌐 Lightweight internationalization plugin for Vue.js 3

i18n-kit

🌐 Lightweight internationalization plugin for Vue.js 3

Note

🚧 Work in Progress

i18n-kit is currently in active development and not usable for production yet.

🌟 Features

• 100% TypeSafe
• Lightweight (0.47 kB gzipped)
• i18n resource pre-compilation

Install

pnpm add @i18n-kit/vue

Usage

// main.ts
import { createApp } from 'vue'
import { createI18n } from '@i18n-kit/vue'

import uz from '../locales/uz.json'
import en from '../locales/en.json'

const i18n = createI18n({
  locale: 'uz',
  messages: { uz, ru }
})

const app = createApp(App)

app.use(i18n)

app.mount('#app')

// App.vue
<template>
  <div>
    <h3>
      {{ $t('message.hello') }}
    </h3>
  </div>
</template>

Message Format Syntax

i18n-kit supports interpolation using placeholders {{}}

const messages = {
  en: {
    message: {
      hello: '{{msg}} world'
    }
  }
}

<p>{{ $t('message.hello', { msg: 'hello' }) }}</p>

Hook

import { useI18n } from '@i18n-kit/vue'

const { t, setLocale } = useI18n()

Type Safety

import uz from '../locales/uz.json'
import en from '../locales/en.json'

const messages = { uz, ru }

declare module '@i18n-kit/vue' {
  interface Register {
    messages: typeof messages
  }
}

const i18n = createI18n({
  locale: 'uz',
  messages
})

Unplugin

pnpm add -D @i18n-kit/unplugin

// vite.config.ts
import { defineConfig } from 'vite'
import i18nPlugin from '@i18n-kit/unplugin/vite'

export default defineConfig({
  plugins: [
    i18nPlugin({ /* options */ }),
  ],
})

Usage

// ./locales/en.json
{
  "message": {
    "hello": "Hello World",
    "foo": "bar"
  },
  "test": "Test Message"
}

// App.vue
<template>
  <div>
    {{ $('test') }}
    <h3>
      {{ $t('message.hello') }}
    </h3>
  </div>
</template>

Will be transformed to:

// ./locales/en.json
{
  "a": "Hello World",
  "b": "bar",
  "c": "Test Message"
}

// App.vue
<template>
  <div>
    {{ $('c') }}
    <h3>
      {{ $t('a') }}
    </h3>
  </div>
</template>

@i18n-kit/unplugin can use the bundler virtual mechanism to import all locales at once, using the special identifier @i18n-kit/messages, as the bellow:

// main.ts
import { createApp } from 'vue'
import { createI18n } from '@i18n-kit/vue'

import messages from '@i18n-kit/messages'

const i18n = createI18n({
  locale: 'uz',
  messages,
})

const app = createApp(App)

app.use(i18n)

app.mount('#app')

Options

i18nPlugin({
 ...
})

interface KeepOption {
  /**
   * Path to i18n resources
   * @default './locales'
   */
  locales?: string
  /**
   * Filepath to generate corresponding .d.ts file.
   * Defaults to './i18n.d.ts' when `typescript` is installed locally.
   * Set `false` to disable.
   * @default false
   */
  dts?: boolean | string

  /**
   * Lazy load i18n resources
   * @default false
   */
  lazyLoadMessages?: boolean
}

Translate

npx @i18n-kit/translate --locales path/to/messages --from en