Package Reference
Support & Contact
Getting help
Most integration issues are configuration or styling related — missing Tailwind @source paths, 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
npm install @realtimexsco/live-chat react react-dom zustand tailwindcss- Node.js 18 or later
- Tailwind v4 plugin installed (
@tailwindcss/viteor@tailwindcss/postcss) - Package version
1.1.56+ if you customize drawers - Types present at
node_modules/@realtimexsco/live-chat/dist/index.d.ts
CSS and theme
- Import
tailwindcssand@realtimexsco/live-chat/styles.css @sourcepoints atdist/index.mjsanddist/index.cjswith the correct relative depth:rootdefines--chat-themeand--chat-theme-5through--chat-theme-60@theme inlinemaps the matching--color-chat-theme*tokens
Runtime config
chat.config.tshas realclientId,accessToken,apiUrl, andsocketUrlloggedUserDetails._idmatches the JWT_id- Chat page uses
h-dvh min-h-0 overflow-hiddenor an explicitviewportHeight - Next.js:
"use client"+transpilePackages - Vite:
optimizeDeps.excludeincludes the chat package
Optional customization
componentsfor custom UI slotsclassNamesfor theme tweaksfeaturesfor phone/video callbackslayoutto hide sectionscolorModesynced 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.