RealTimeX
Sign inStart for free
RealTimeXMobile Package
Introduction5-minute overviewFeaturesHow the package worksGlossary
Requirements & dependenciesBackend credentialsInstallation step by stepTutorial — your first chat appProject config fileApp entry — index.jsQuick start — minimum working chatComplete ChatScreen example
Native configuration (iOS & Android)Firebase, APNs & backend setup
Navigation — embedding the chatSession, auth & Socket.IOPermissions & access controlAudio & video callingPush notificationsMentions viewRich-text messages (WebView editor)Total unread count
Customization — four waysDefault component fallback (important)Which slots are wiredCustomization examples (Case 1–4)UI feature flags & copy (ui)Chat info (group + DM)Style overrides (ui.styles)Render props (ChatProvider)Theme, fonts & appearance
ChatProvider props referenceconfigureChat options referenceHooks & storeCallbacks referenceAPI query paramsAll exports
Production integration pattern (Fieldr)Host app integration — providers, toasts, tab bars & navigationEnvironment variablesLocal package / monorepo (Metro)
TroubleshootingSetup checklistArchitectureDocumentation & file mapPackage development (maintainers)License
Mobile packageGetting Started

Project config file

Create src/configs/chat.config.ts — credentials and app-wide options only — and import it everywhere you render chat:

typescriptsrc/configs/chat.config.ts
1// src/configs/chat.config.ts2import type {ConfigureChatOptions} from '@realtimexsco/live-chat-react-native';3import {getHostAccessToken} from '../auth/session'; // your app's token getter4 5export const chatConfig: ConfigureChatOptions = {6  apiUrl: 'https://realtimex.softwareco.com/api/v1',7  socketUrl: 'https://realtimex.softwareco.com', // optional — derived from apiUrl8  clientId: 'YOUR_CLIENT_ID',9  accessToken: () => getHostAccessToken(), // or a static string10  callUri: 'https://realtimex.softwareco.com/api/v2', // calls + push11  theme: {colorMode: 'light', accent: '#6366f1'},12  onSessionEnd: ({reason}) => {13    // the server signed the user out — go to your login screen14  },15};
OptionRequiredPurpose
apiUrlYesChat REST base
clientIdYesTenant id
accessTokenYesHost user token (string or getter)
socketUrlNoSocket origin; derived from apiUrl
callUriCalls / pushCalls and notifications base (…/api/v2)
Everything elseNoconfigureChat options reference
PreviousTutorial — your first chat appNextApp entry — index.js