smaq-chatbot v0.1.0
SmaqChatbot
A beautiful, customizable floating chat component for React applications.
Installation
npm install smaq-chatbot
Usage
import { SmaqChatbot } from 'smaq-chatbot';
import 'smaq-chatbot/styles.css';
function App() {
return (
<SmaqChatbot
apiKey="your-api-key"
projectId="your-project-id"
theme={{
primaryColor: 'bg-zinc-900',
glassMorphism: true,
bubbleSize: 'medium',
}}
initialMessage="Hello! How can I help you today?"
/>
);
}
Props
Prop | Type | Description |
---|---|---|
apiKey | string | Your API key for the chat service |
projectId | string | Your project ID |
theme | ChatTheme | Customize the appearance of the chat component |
initialMessage | string | First message shown in the chat |
placeholder | string | Placeholder text for the input field |
className | string | Additional CSS classes |
params | object | Additional parameters to pass to the API |
Theme Options
The theme
prop accepts an object with the following properties:
interface ChatTheme {
primaryColor?: string;
backgroundColor?: string;
textColor?: string;
fontFamily?: string;
position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
bubbleSize?: 'small' | 'medium' | 'large';
windowSize?: 'small' | 'medium' | 'large';
glassMorphism?: boolean;
companyName?: string;
logoUrl?: string;
}
License
MIT License
Copyright (c) 2025 SMAQ
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
5 months ago