Skip to main content

Internationalization

Global IM UIKit natively supports two languages: zh_CN and en_US, with en_US being the default language.

Changing the Default Language​

You can modify the default language configuration during SDK initialization by using the lang parameter, based on your business needs.

import { RCKitInstaller } from '@rongcloud/global-im-uikit';

const kitApp = RongIMLib.installPlugin(RCKitInstaller, {
  // ...
  language: 'zh_CN', // Default is 'en_US'
  // ...
});

Switching Languages​

Global IM UIKit supports runtime language switching. You can change the language using the setLanguage method, and the SDK will immediately update the language displayed in the UI.

kitApp.setLanguage('zh_CN');

Additionally, the SDK provides the getLanguage method to retrieve the current language identifier.

const language = kitApp.getLanguage();

Customizing Language Packs​

tip

The custom language pack feature is only effective if called before kitApp.ready().

Global IM UIKit supports custom language pack extensions, allowing the business layer to adapt to more language environments. The core APIs are:

  • cloneLanguageEntries: Used to obtain a copy of the built-in language pack entries for extension or modification.
  • registerLanguagePack: Registers a language pack, which can also be used to override existing language packs, such as zh_CN.

Code Example

// Get a copy of the built-in Simplified Chinese language pack entries
const entries = kitApp.cloneLanguageEntries('zh_CN');

// Modify the entries to Traditional Chinese
// ...
entrise['alert.send.message.maxcount'] = '內容超過 {0} 字，請刪除部分內容後再嘗試發送';
// ...

// Register a new language pack for zh_HK
kitApp.registerLanguagePack('zh_HK', entries);

If you are a Typescript developer, you can also define a custom language pack from scratch using the IRCKitLanguageEntries interface.

import { IRCKitLanguageEntries } from '@rongcloud/global-im-uikit';

const entries: IRCKitLanguageEntries = {
  // ...
  'alert.send.message.maxcount': '內容超過 {0} 字，請刪除部分內容後再嘗試發送',
  // ...
};

// Register a new language pack for zh_HK
kitApp.registerLanguagePack('zh_HK', entries);

Retrieving the Language Pack List​

You can use the getSupportedLanguages method to obtain the list of language identifiers supported by Global IM UIKit. If the business layer has added custom language packs, they will also be included in the returned results.

const list = kitApp.getSupportedLanguages(); // ['zh_CN', 'en_US']
Last updated on