agtic/keycloak_theme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update i18n API JSDoc comments

Browse Source
This commit is contained in:
garronej 2022-08-26 15:43:32 +07:00
parent 9a9fc56f85
commit 5997416e1b
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib/i18n/index.tsx
View File

@ -27,12 +27,13 @@ export type I18n<MessageKey extends string = MessageKeyBase> = {
*/ */
currentLanguageTag: string; currentLanguageTag: string;
/** /**
* To call when the user switch language.
* This will cause the page to be reloaded, * This will cause the page to be reloaded,
* on next load currentLanguageTag === newLanguageTag * on next load currentLanguageTag === newLanguageTag
*/ */
changeLocale: (newLanguageTag: string) => never; 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. * 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 * ex: https://user-images.githubusercontent.com/6702424/186044799-38801eec-4e89-483b-81dd-8e9233e8c0eb.png
@ -53,8 +54,8 @@ export type I18n<MessageKey extends string = MessageKeyBase> = {
msgStr: (key: MessageKey, ...args: (string | undefined)[]) => string; msgStr: (key: MessageKey, ...args: (string | undefined)[]) => string;
/** /**
* Examples assuming currentLanguageTag === "en" * Examples assuming currentLanguageTag === "en"
* advancedMsg("${access-denied} foo bar") === msg("access-denied") + " foo bar" === <span>Access denied foo bar</span> * advancedMsg("${access-denied} foo bar") === <span>${msgStr("access-denied")} foo bar<span> === <span>Access denied foo bar</span>
* advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied") * advancedMsg("${access-denied}") === advancedMsg("access-denied") === msg("access-denied") === <span>Access denied</span>
* advancedMsg("${not-a-message-key}") === advancedMsg(not-a-message-key") === <span>not-a-message-key</span> * advancedMsg("${not-a-message-key}") === advancedMsg(not-a-message-key") === <span>not-a-message-key</span>
*/ */
advancedMsg: (key: string, ...args: (string | undefined)[]) => JSX.Element; advancedMsg: (key: string, ...args: (string | undefined)[]) => JSX.Element;