cometchat-i18n
Ground truth: localization is the
CometChatLocalizeclass on React, Angular, iOS and Android. Two exceptions: React Native usesCometChatI18nProvider+ theuseCometChatTranslationhook (there is noCometChatLocalizein the RN kit — catalog-confirmed), and Flutter is moving toCometChatLocalizebut the shipping 6.1.0 kit still exposesTranslations(seecometchat-flutter-v6-customization→ Localization — STAGED pending the kit). Exact methods and built-in string keys differ by family and major — FETCH the signature from the resolved family's localize doc viacometchat-<family>-core/references/docs-map.md(intent: localization / localize). Do not carry an API across families or majors (v6 React, for one, renamed language codes and keys). Never assert a key set from memory — look it up in the kit'sresources/<lang>/translation.json/ the localize page.
Use this skill when
Making the chat speak another language, shipping to a multi-locale or RTL market, adding/overriding wording, or fixing a UI that shows a raw key (e.g. group_info) instead of text.
The mechanism (per family, one shape)
Most UI Kits localize through CometChatLocalize (React Native is the exception — it uses CometChatI18nProvider + the useCometChatTranslation hook): it can detect the user's browser/device language and set the active locale, and it exposes the current locale to components (which read their strings from it). The three things you do:
- Set the locale — let it auto-detect, or set it explicitly to match your app's language switcher. Do this before the surface renders (alongside init), so components mount already localized. (React v7: pass the
localeprop onCometChatProvider—<CometChatProvider locale="fr">— applied on mount/change.) - Register custom / overridden translations — add your own strings or override the kit defaults per locale (e.g. React v7:
CometChatLocalize.getSharedInstance()?.addTranslation({ "en-us": { key: "value" } })— an INSTANCE method taking a nested per-language map; reach the live instance viagetSharedInstance(), nevernew CometChatLocalize(); other families have the equivalent — React Native instead uses theCometChatI18nProvidertranslationsprop, keyed on the active language code: under the default auto-detect that's the 2-letter device code, so usetranslations={{ "en": { KEY: "value" } }}— a regional key likeen-USis ignored unless you also passselectedLanguage="en-US", and codes must match the kit's keys exactly (case-sensitive) — e.g.zh-twis lowercase buten-US/en-GBare uppercase-region; notaddTranslation. Provider props:selectedLanguage·autoDetectLanguage·translations·fallbackLanguage—{DOCS_BASE}/ui-kit/react-native/localize). Fetch the exact call for your family. - Read a string yourself where you render kit text in your own markup — use the family's localized-string accessor (React v7:
useLocale().getLocalizedString(key)), never a hardcoded English literal.
The exact class methods, the supported language list, and the key namespace are per family+major — fetch them; this file is the discipline, the docs are the signatures.
Never render a raw key
A snake_case token in the UI (group_info, add_members, sample_*) means a missing or wrong key — the localizer returns the key on a miss. Causes and fixes:
- The component isn't inside the kit provider/localization context → wrap it (the provider auto-wires localization).
- The key changed across majors (v5→v6/v7 moved keys, some under
sample_*) → look up the CURRENT key in the kit'sresources/<lang>/translation.jsonor the localize doc; don't guess. - You hardcoded a raw key as a label → use the component or the localized-string accessor.