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 packageAPI Reference

ChatProvider props reference

PropDefaultPurpose
config—Same options as configureChat. Applied on mount and when apiUrl / socketUrl / clientId / static accessToken change. Later ui / showSearch / showVideoCall / showVoiceCall changes apply live
autoConnecttrueRestore / bootstrap the session and connect Socket.IO. Set false only if you call bootstrapChatSession() yourself
withSafeAreatrueWrap with SafeAreaProvider
withGestureRoottrueWrap with GestureHandlerRootView
withToasttrueMount a react-native-toast-message host (success / error / info / in-app notification banner)
renderConversationItem, renderConversationList, renderHeader, renderFooter, renderMessage—Render props

Without config, ChatProvider uses configureChat() values, then env values from react-native-config. Note: importing ChatProvider calls LogBox.ignoreAllLogs() — yellow-box warnings are hidden in development.

PreviousTheme, fonts & appearanceNextconfigureChat options reference