Internationalization for H3

[!NOTE] You’re viewing the srvmid repository, which is developing for H3 v2. If you want to check H3 v1, please see the @intlify/h3 repository

🌟 Features

✅️️  Internationalization utils: support internationalization utils via @intlify/utils

✅️  Translation: Simple API like vue-i18n

✅  Custom locale detector: You can implement your own locale detector on server-side

💿 Installation

# Using npm
npm install @intlify/h3

# Using yarn
yarn add @intlify/h3

# Using pnpm
pnpm add @intlify/h3

# Using bun
bun add @intlify/h3

🚀 Usage

Detect locale with utils

Detect locale from accept-language header:

import { H3 } from 'h3'
import { getHeaderLocale } from '@intlify/h3'

const app = new H3()

app.get('/', event => {
  // detect locale from HTTP header which has `Accept-Language: ja,en-US;q=0.7,en;q=0.3`
  const locale = getHeaderLocale(event.req)
  return locale.toString()
})

Detect locale from URL query:

import { H3 } from 'h3'
import { getQueryLocale } from '@intlify/h3'

const app = new H3()

app.get('/', event => {
  // detect locale from query which has 'http://localhost:3000?locale=en'
  const locale = getQueryLocale(event.req)
  return locale.toString()
})

Translation

If you want to use translation, you need to install intlify plugin. As a result, you can use useTranslation within the handler:

import { createServer } from 'node:http'
import { H3, toNodeListener } from 'h3'
import { intlify, detectLocaleFromAcceptLanguageHeader, useTranslation } from '@intlify/h3'

// install `intlify` plugin with `H3` constructor
const app = new H3({
  plugins: [
    // configure plugin options
    intlify({
      // detect locale with `accept-language` header
      locale: detectLocaleFromAcceptLanguageHeader,
      // resource messages
      messages: {
        en: {
          hello: 'Hello {name}!'
        },
        ja: {
          hello: 'こんにちは、{name}！'
        }
      }
      // something options
      // ...
    })
  ]
})

app.get('/', async event => {
  // use `useTranslation` in event handler
  const t = await useTranslation(event)
  return t('hello', { name: 'h3' })
})

createServer(toNodeListener(app)).listen(3000)

🛠️ Custom locale detection

You can detect locale with your custom logic from current H3Event.

example for detecting locale from url query, and get locale with getDetectorLocale util:

import { H3 } from 'h3'
import { intlify, getQueryLocale, getDetectorLocale } from '@intlify/h3'

import type { H3Event } from 'h3'

// define custom locale detector
const localeDetector = (event: H3Event): string => {
  return getQueryLocale(event.req).toString()
}

const app = new H3({
  plugins: [
    intlify({
      // set your custom locale detector
      locale: localeDetector
      // something options
      // ...
    })
  ]
})

app.get('/', async event => {
  const locale = await getDetectorLocale(event)
  console.log(`Current Locale: ${locale.language}`)
})

You can make that function asynchronous. This is useful when loading resources along with locale detection.

[!NOTE] The case which a synchronous function returns a promise is not supported. you need to use async function.

import { H3 } from 'h3'
import { intlify, getCookieLocale } from '@intlify/h3'

import type { H3Event } from 'h3'
import type { DefineLocaleMessage, CoreContext } from '@intlify/h3'

const loader = (path: string) => import(path).then(m => m.default)
const messages: Record<string, () => ReturnType<typeof loader>> = {
  en: () => loader('./locales/en.json'),
  ja: () => loader('./locales/ja.json')
}

// define custom locale detector and lazy loading
const localeDetector = async (
  event: H3Event,
  intlify: CoreContext<string, DefineLocaleMessage>
): Promise<string> => {
  // detect locale
  const locale = getCookieLocale(event.req).toString()

  // resource lazy loading
  const loader = messages[locale]
  if (loader && !intlify.messages[locale]) {
    const message = await loader()
    intlify.messages[locale] = message
  }

  return locale
}

const app = new H3({
  plugins: [
    intlify({
      // set your custom locale detector
      locale: localeDetector
      // something options
      // ...
    })
  ]
})

🖌️ Resource keys completion

[!NOTE] Resource Keys completion can be used if you are using Visual Studio Code

You can completion resources key on translation function with useTranslation.

resource keys completion has two ways.

Type parameter for useTranslation

[!NOTE] The exeample code is here

You can useTranslation set the type parameter to the resource schema you want to key completion of the translation function.

the part of example:

app.get('/', async event => {
  type ResourceSchema = {
    hello: string
  }
  // set resource schema as type parameter
  const t = await useTranslation<ResourceSchema>(event)
  // you can completion when you type `t('`
  return t('hello', { name: 'h3' })
})

global resource schema with declare module '@intlify/h3'

[!NOTE] The exeample code is here

You can do resource key completion with the translation function using the typescript declare module.

the part of example:

import en from './locales/en.ts'

// 'en' resource is master schema
type ResourceSchema = typeof en

// you can put the type extending with `declare module` as global resource schema
declare module '@intlify/h3' {
  // extend `DefineLocaleMessage` with `ResourceSchema`
  export interface DefineLocaleMessage extends ResourceSchema {}
}

app.get('/', async event => {
  const t = await useTranslation(event)
  // you can completion when you type `t('`
  return t('hello', { name: 'h3' })
})

The advantage of this way is that it is not necessary to specify the resource schema in the useTranslation type parameter.

🛠️ Utilities & Helpers

@intlify/h3 has a concept of composable utilities & helpers.

See the API References

🙌 Contributing guidelines

If you are interested in contributing to @intlify/h3, I highly recommend checking out the contributing guidelines here. You'll find all the relevant information such as how to make a PR, how to setup development) etc., there.

🤝 Sponsors

The development of srvmid is supported by my OSS sponsors!

©️ License

MIT