orbitel-chat-bot
v0.0.3
Published
A beautiful, embeddable chatbot widget for React applications.
Readme
Orbitel Chatbot SDK
A beautiful, embeddable chatbot widget for React applications.
Installation
npm install orbitel-chat-bot
# or
yarn add orbitel-chat-botUsage
import { ChatWidget } from 'orbitel-chat-bot';
function App() {
const chatbotConfig = {
botId: 'your-bot-id',
accessKey: 'your-access-key',
botName: 'Support Bot',
botAvatar: '/avatar.png',
position: 'bottom-right' // or 'bottom-left'
};
return (
<div>
<ChatWidget config={chatbotConfig} />
</div>
);
}Configuration
| Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | botId | string | Yes | - | Your bot identifier | | accessKey | string | Yes | - | Your access key for authentication | | botName | string | No | 'Support Bot' | Display name for the bot | | botAvatar | string | No | '/placeholder.svg' | URL to bot avatar image | | primaryColor | string | No | '#00b4d8' | Primary color for the widget | | position | 'bottom-right' | 'bottom-left' | No | 'bottom-right' | Position of the chat button |
Features
- 🎨 Beautiful, modern UI with smooth animations
- 📱 Fully responsive design
- 🌙 Dark mode support
- ⚡ Lightweight and performant
- 🔧 Easy to customize
- 🚀 Simple integration
Building for NPM
License
MIT
