Skip to main content
Version: v4

Localize

Overview​

CometChat UI Kit provides language localization to adapt to the language of a specific country or region. The CometChatLocalize class allows you to detect the language of your users based on their browser or device settings, and set the language accordingly.

CometChatLocalize is a class that includes methods related to locale. Developers can use these methods to change the language of the UI Kit library.

Presently, the UI Kit supports 12 languages for localization, which are:

  • English (en, en-US, en-GB)
  • Chinese (zh, zh-TW)
  • Spanish (es)
  • Hindi (hi)
  • Russian (ru)
  • Portuguese (pt)
  • Malay (ms)
  • French (fr)
  • German (de)
  • Swedish (sv)
  • Lithuanian (lt)
  • Hungarian (hu)

Methods​

Here are the methods included in the CometChatLocalize class:

  • init(): This method is used for setting the language in the UI Kit. It will take the constant value from the Language class and set the value accordingly.

  • localize(String text): This method is used to translate the provided text to the active language.

  • setLocale(language: string): This method is used to set the language in the UI Kit. It will take the constant value from the Language class and set the value accordingly.

  • getLocale(): This method is used to get the current language. By default, it will return the current language from the device/browser.

Usage​

Here is how you can put these methods into use:

CometChatLocalize.setLocale("hi");

let currentLanguage = CometChatLocalize.getLocale();

By using the CometChatLocalize class, you can provide a user-friendly, localized experience to your users, enhancing the overall user experience within your application.