nsh/i18n

nsh/i18n shows the app’s text in the user’s language. The translations are the app’s locales/ files, in rust-i18n’s formats, which the build reads and the bundle carries; the API is rust-i18n’s, and Rust components have the same as t!, set_locale and available_locales in nsh_core::prelude. I18n walks through translating an app.

import { availableLocales, setLocale, t } from "nsh/i18n";

It works on every platform, the web included.

#t

function t(key: string, options?: { locale?: string; [name: string]: unknown }): string;

The text of key in the language the app shows: the first of the user’s preferred languages (localeSettings().languages) the app has translations in, else locale()’s.

• options’ members other than locale fill the text’s %{name} patterns, written as text (String(value)).
• options.locale asks for the text in another language.
• A key a language lacks comes from the language without its last subtag (zh-Hant-TW, zh-Hant, zh), then from English (en). Where no language has it, the text is <locale>.<key>.
• Reading it subscribes to the language and the translations: a text that shows it updates with setLocale, the user’s settings and, in development, the files.

<Text>{t("cart.items", { count: items().length })}</Text>

#setLocale

function setLocale(locale: string | null): void;

Shows the app in locale, a BCP 47 tag ("zh-CN"), whatever the user’s language: t, locale(), the first of localeSettings().languages and Intl’s default locale follow it at once. null follows the user’s language again. A string that is not a language tag throws a RangeError. The choice lasts while the app runs, on its surface only.

#availableLocales

function availableLocales(): string[];

The languages the app has translations in, as its files name them, sorted (["en", "ja", "zh-CN"]).

#Files

locales/, beside nsh.json, holds rust-i18n’s files: YAML, JSON or TOML, one per language (en.yml, app.zh-CN.yml) or one with every language (_version: 2). Keys nest with dots. See Translation files.

#nsh.json

"locales" lists the languages whose number and date data the bundle carries, besides English; without it, the languages of the translations (Numbers and dates).