diff --git a/src/lib/i18n/index.tsx b/src/lib/i18n/index.tsx index f2e0f516..2d9d8bb2 100644 --- a/src/lib/i18n/index.tsx +++ b/src/lib/i18n/index.tsx @@ -27,12 +27,13 @@ export type I18n = { */ currentLanguageTag: string; /** + * To call when the user switch language. * This will cause the page to be reloaded, * on next load currentLanguageTag === newLanguageTag */ changeLocale: (newLanguageTag: string) => never; /** - * e.g. "en" => "English", "fr" => "Français" + * e.g. "en" => "English", "fr" => "Français", ... * * Used to render a select that enable user to switch language. * ex: https://user-images.githubusercontent.com/6702424/186044799-38801eec-4e89-483b-81dd-8e9233e8c0eb.png @@ -53,8 +54,8 @@ export type I18n = { msgStr: (key: MessageKey, ...args: (string | undefined)[]) => string; /** * Examples assuming currentLanguageTag === "en" - * advancedMsg("${access-denied} foo bar") === msg("access-denied") + " foo bar" === Access denied foo bar - * advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied") + * advancedMsg("${access-denied} foo bar") === ${msgStr("access-denied")} foo bar === Access denied foo bar + * advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied") === Access denied * advancedMsg("${not-a-message-key}") === advancedMsg(not-a-message-key") === not-a-message-key */ advancedMsg: (key: string, ...args: (string | undefined)[]) => JSX.Element;