Appearance
useInternationalization
Definition
Composable for internationalization management.
Basic usage
ts
const {
languages,
currentLanguage,
currentPrefix,
getStorefrontUrl,
getAvailableLanguages,
changeLanguage,
getLanguageCodeFromId,
getLanguageIdFromCode,
replaceToDevStorefront
} = useInternationalization();
Signature
ts
export function useInternationalization(): UseInternationalizationReturn
Return type
See UseInternationalizationReturn
ts
export type UseInternationalizationReturn = {
/**
* StorefrontUrl is needed to specify language of emails
*/
getStorefrontUrl(): string;
getAvailableLanguages(): any;
changeLanguage(languageId: string): Promise<ContextTokenResponse>;
getLanguageCodeFromId(languageId: string): string;
getLanguageIdFromCode(languageCode: string): string;
replaceToDevStorefront(url: string): string;
languages: Ref<Language[]>;
currentLanguage: Ref<string>;
currentPrefix: Ref<string>;
};
Properties
| Name | Type | Description |
|---|---|---|
| languages | Ref<Array<Language>> | |
| currentLanguage | Ref<string> | |
| currentPrefix | Ref<string> |
Methods
| Name | Type | Description |
|---|---|---|
| getStorefrontUrl | string | StorefrontUrl is needed to specify language of emails |
| getAvailableLanguages | any | |
| changeLanguage | Promise<ContextTokenResponse> | |
| getLanguageCodeFromId | string | |
| getLanguageIdFromCode | string | |
| replaceToDevStorefront | string |