Translating text
Last updated:
On this page
These work like their Laravel counterparts.
import { __, trans, has } from "@javaabu/i18n"
__("Welcome, :name!", { name: "Ali" })
trans("messages.welcome")
__("messages.welcome", {}, "dv") // a specific locale
has("messages.welcome")
__() and trans() are the same, apart from what they do without a key: __() returns null and trans() returns the translator.
Lookups
A key is looked up in this order:
- A JSON line, like
"Hello"inlang/dv.json, for the current locale. - A language file line, like
helloinlang/dv/messages.php, for the current locale. - The same language file line for the fallback locale.
When nothing is found you get the key back, with replacements made. So __("Hello, :name", { name: "Ali" }) gives Hello, Ali even with no translations loaded.
Note
JSON lines don't fall back, in Laravel or here. If Hello is only in en.json, __("Hello") in dv returns Hello. Language file lines (messages.hello) do fall back.
These key styles all work:
__("messages.nested.line")
__("dir/file.line") // lang/en/dir/file.php
__("package::file.line") // vendor packages
A key that points at a group returns the whole group. TypeScript assumes a string, so say when you expect a group:
import { __, type Messages } from "@javaabu/i18n"
const messages = __<Messages>("messages")
Replacements
The case of the placeholder sets the case of the value:
__("Welcome, :name", { name: "ali" }) // Welcome, ali
__("Welcome, :Name", { name: "ali" }) // Welcome, Ali
__("Welcome, :NAME", { name: "ali" }) // Welcome, ALI
A function handles a pair of tags:
__("Read the <link>terms</link>", { link: (text) => `<a href="/terms">${text}</a>` })
Warning
As in Laravel, the result isn't escaped. Escape anything you insert before putting the result in innerHTML, v-html or dangerouslySetInnerHTML.
Missing keys
To log keys that have no translation, or show something else for them:
import { translator } from "@javaabu/i18n"
translator.handleMissingKeysUsing((key, replace, locale) => {
console.warn(`No ${locale} translation for ${key}`)
})