Universal Chat Popup

Introduction

This repository contains my personal customization of the Just-Chat widget, a lightweight chat solution for websites. I've adapted the original work to better suit my specific needs while maintaining the core functionality and principles of the original project.

Credit goes to the original author, Hoang Kieng ([email protected]), for creating the foundation of this excellent chat widget. The original repository can be found at https://github.com/draphonix/just-chat.

My customizations focus on enhancing specific features while preserving the lightweight nature of the original implementation. This README documents both the original functionality and my additions.

A lightweight, customizable chat widget that can be easily embedded into any website. Built with Web Components for maximum compatibility and style isolation.

Features

• 🎨 Customizable theme and appearance
• 💾 Local chat history persistence
• 🔌 Simple webhook integration
• 🎯 Zero dependencies
• 🛡️ Style isolation via Shadow DOM
• 📱 Responsive design
• ⌨️ Keyboard accessible
• 🔄 Message status indicators
• ❌ Request cancellation support
• 🔒 Secure by default
• 🌐 Cross-browser compatible
• 🚀 Small bundle size (~4KB gzipped)

Installation

Via CDN (Recommended)

<!-- Latest version -->
<script src="https://cdn.jsdelivr.net/npm/@arisng/just-chat/dist/just-chat.umd.js"
        data-webhook-url="https://your-backend.com/chat"
        data-theme-color="#1E40AF"
        data-position="bottom-right"
        data-title="Chat with us"
        data-welcome-message="How can we help you today?"
        data-history-enabled="true"
        data-history-clear-button="true"
        defer>
</script>

<!-- Specific version -->
<script src="https://cdn.jsdelivr.net/npm/@arisng/[email protected]/dist/just-chat.umd.js"
        data-webhook-url="https://your-backend.com/chat"
        defer>
</script>

Via NPM

# Using npm
npm install @arisng/just-chat

# Using pnpm
pnpm add @arisng/just-chat

# Using yarn
yarn add @arisng/just-chat

import { initChatPopup } from '@arisng/just-chat';

initChatPopup({
  webhookUrl: 'https://your-backend.com/chat',
  themeColor: '#1E40AF',
  position: 'bottom-right',
  title: 'Chat with us',
  welcomeMessage: 'How can we help you today?',
  history: {
    enabled: true,
    clearButton: true
  }
});

Configuration

| Option | Type | Default | Description | |--------|------|---------|-------------| | webhookUrl | string | - | (Required) Backend endpoint URL for processing messages | | themeColor | string | '#1E40AF' | Primary color for UI elements | | position | 'bottom-right' | 'bottom-left' | 'bottom-right' | Widget position on screen | | title | string | 'Chat with us' | Chat window title | | welcomeMessage | string | '' | Initial message shown when chat opens | | history.enabled | boolean | true | Enable/disable chat history persistence | | history.clearButton | boolean | true | Show/hide the clear history button |

Features in Detail

Message Status Indicators

Messages show their current status:

• 🔄 Sending: Message is being sent to the webhook
• ✅ Sent: Message was successfully delivered
• ❌ Error: Failed to send message
• ⚪ Cancelled: User cancelled the message

History Management

Chat history is stored in LocalStorage:

• Persists across page reloads
• Separate storage per webhook URL
• Optional clear history button
• Automatic loading of previous messages

Webhook Integration

The widget sends POST requests to your webhook URL with the following JSON payload:

{
  message: string;          // User's message
  timestamp: string;        // ISO8601 timestamp
  sessionId: string;        // Unique session identifier
  context: {
    url: string;           // Current page URL
  };
  history?: Array<{        // Last 10 messages (if any)
    id: string;
    text: string;
    sender: 'user' | 'backend' | 'system';
    timestamp: string;
  }>;
}

Expected response format:

{
  response: string;        // Text message to display to the user
}

Security Features

• Content Security Policy (CSP) compatible
• No eval() or inline scripts
• XSS protection for message rendering
• CORS support for webhook requests
• Secure by default configuration

Browser Support

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)
• Mobile browsers

Accessibility

• ARIA labels and roles
• Keyboard navigation
• Focus management
• Screen reader support
• High contrast support

Development

Prerequisites

• Node.js 18+
• pnpm (recommended) or npm

Setup

1. Clone the repository

git clone https://github.com/draphonix/just-chat.git
cd just-chat

2. Install dependencies

pnpm install

3. Start development server

pnpm dev

4. Build for production

pnpm build

Testing the Widget

1. Start the mock server

pnpm start

2. Open http://localhost:3000 in your browser
3. Try the demo features:
   • Send messages
   • Cancel messages
   • Clear history
   • Change theme color
   • Test responsiveness

Project Structure

just-chat/
├── src/
│   ├── components/        # Web Components
│   │   ├── base-component.ts
│   │   ├── chat-widget.ts
│   │   ├── chat-launcher.ts
│   │   └── chat-window.ts
│   ├── services/         # Core services
│   │   ├── storage.ts
│   │   └── webhook.ts
│   └── main.ts          # Entry point
├── dist/                # Built files
├── mock-server.js      # Test server
└── package.json

Contributing

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request

License

MIT

Support

• GitHub Issues: Report a bug
• Email: [email protected]

Credits

Built with:

• TypeScript
• Web Components
• Vite
• Express (mock server)# just-chat