RealTimeX
Sign inStart for free
RealTimeXWeb Package
IntroductionPrerequisitesInstallationProject setupQuick start
Package structureConfigurationComponentsHooksAPI integrationSocket events
OverviewReplace entire UIReplace componentsStyle with classNamesThemes & localePhone & video callingIn-call control barFeatures
Unread badgeRich-text messagesPins, stars & datesMessage threadsMentionsCanvas & draftsNotificationsAdmin permissionsServer refusalsSession & token refresh
Host app integrationTroubleshootingFAQVersion historyBest practicesSupport & contact
Web packageHelp & reference

Support & Contact

Getting help

Most integration issues are configuration or styling related - a missing styles.css import, a host z-index above chat modals, an incorrect JWT user id, or a broken height chain. Start with the guides below before opening a support ticket.

  • Troubleshooting - symptom → cause → fix table
  • FAQ - short answers to common questions
  • Best Practices - recommended patterns for production apps

Setup checklist

Use this list when embedding the package in a new project. Tick each item before debugging application logic.

Install

shell
npm install @realtimexsco/live-chat react react-dom
  • Node.js 18 or later
  • Lexical, DOMPurify, Zustand and the rest install with the package - don't add them yourself
  • Using calling: @videosdk.live/react-sdk at 0.13.3 (not 1.x)
  • Package version 1.1.56+ if you customize drawers
  • Types present at node_modules/@realtimexsco/live-chat/dist/index.d.ts

CSS and theme

  • @realtimexsco/live-chat/styles.css imported once in global CSS (no @source needed)
  • Chat modals appear above your app's sidebar / header z-index
  • :root defines --chat-theme and --chat-theme-5 through --chat-theme-60
  • @theme inline maps the matching --color-chat-theme* tokens

Runtime config

  • chat.config.ts has real clientId, accessToken, apiUrl, and socketUrl
  • loggedUserDetails._id matches the JWT _id
  • Chat page uses h-dvh min-h-0 overflow-hidden or an explicit viewportHeight
  • Next.js: "use client" + transpilePackages
  • Vite: dedupe React, and (pnpm) nested chat entries in optimizeDeps.include

Optional customization

  • components for custom UI slots
  • classNames for theme tweaks
  • features for phone/video callbacks
  • layout to hide sections
  • colorMode synced with your app theme

Where to look next

  • Installation and Project Setup
  • Quick Start for a minimum working page
  • API docs under /documentations/api when backend contracts are involved

License

The package is released under the MIT License. You may use, copy, modify, and distribute it in accordance with that license. Keep the copyright notice with redistributed copies.

Contact

For product-specific support, bug reports, or feature requests, contact your RealtimeX account team or the support channel included with your subscription. Include your package version, framework (Vite / Next.js), and a minimal reproduction when reporting bugs.

Tip

Before contacting support, confirm the setup checklist above and search Troubleshooting for the same error text - that shortens turnaround significantly.
PreviousBest practices

On this page

Getting helpSetup checklistWhere to look nextLicenseContact
Back to top