Skip to content
On this page

useInternationalization

Definition

Composable for internationalization management.

Basic usage

ts
const { 
 languages,
 currentLanguage,
 getStorefrontUrl,
 getAvailableLanguages,
 changeLanguage,
 getLanguageCodeFromId 
} = 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<void>;
  getLanguageCodeFromId(languageId: string): string;
  languages: Ref<Language[]>;
  currentLanguage: Ref<string>;
};

Properties

NameTypeDescription
languages
Ref<Array<Language>>
currentLanguage
Ref<string>

Methods

NameTypeDescription
getStorefrontUrl
string
StorefrontUrl is needed to specify language of emails
getAvailableLanguages
any
changeLanguage
Promise<void>
getLanguageCodeFromId
string
useInternationalization has loaded