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 packageTroubleshooting & Reference

Package development (maintainers)

This repository is also a runnable demo app (App.tsx, ios/, android/) that reads its config from .env via react-native-config.

ScriptCommandPurpose
npm run startreact-native startMetro
npm run ios / npm run androidreact-native run-ios / run-androidRun the demo app
npm run typechecktsc --noEmitFull type check
npm run lint / npm run lint:fixeslint . --ext .js,.jsx,.ts,.tsx (--fix)Lint
npm run testjestTests in __tests__/
npm run format / npm run format:checkprettier --write . / --check .Formatting
npm run build:rich-editornode scripts/build-rich-editor.jsRebuild src/richEditor/editorHtml.generated.ts from rich-editor/ — run after any editor change and commit the output
npm run android:cleancd android && ./gradlew cleanClean Android build
npm run cleanwatchman, yarn cache, iOS build, pod cache, Android .cxx / build / Gradle cleanFull native reset
npm run releasesemantic-releaseVersion, changelog, npm publish — CI only

Published files (package.json → files): src, android-screenshare, react-native.config.js, RealtimexLiveChat.podspec, RealtimexLiveChatBroadcast.podspec, host-setup, ios/SCREEN_SHARE_HOST_SETUP.md, ios/RealTimeXChat/CallPipModule.h / .m, ios/RealTimeXChat/VideosdkRPK.swift / .m, ios/RealTimeXChat/RealtimexVoip.m, ios/RealtimexBroadcast, README.md, LICENSE, package.json. rich-editor/ and scripts/ are not published — only their generated output in src/.

PreviousDocumentation & file mapNextLicense