https://github.com/raghuchinnannan/wa-chat-widget
Simple Whatsapp Chat Widget for Websites
https://github.com/raghuchinnannan/wa-chat-widget
chat contact contact-form hacktoberfest hacktoberfest-accepted npm npm-module npm-package website-chat-widget-integration whatsapp whatsapp-chat whatsapp-contact-extension whatsapp-web whatsapp-website-chat whatsapp-website-chat-widget widget widget-library
Last synced: 4 months ago
JSON representation
Simple Whatsapp Chat Widget for Websites
- Host: GitHub
- URL: https://github.com/raghuchinnannan/wa-chat-widget
- Owner: raghuchinnannan
- License: other
- Created: 2024-10-27T08:11:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-02T15:02:20.000Z (over 1 year ago)
- Last Synced: 2025-10-30T06:07:48.217Z (7 months ago)
- Topics: chat, contact, contact-form, hacktoberfest, hacktoberfest-accepted, npm, npm-module, npm-package, website-chat-widget-integration, whatsapp, whatsapp-chat, whatsapp-contact-extension, whatsapp-web, whatsapp-website-chat, whatsapp-website-chat-widget, widget, widget-library
- Language: JavaScript
- Homepage: https://a2plugins.com/wa-chat-widget/
- Size: 23.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WhatsApp Chat Widget
[](https://www.npmjs.com/package/wa-chat-widget)
[](https://www.npmjs.com/package/wa-chat-widget)
A lightweight, customizable WhatsApp chat widget that adds a floating WhatsApp button to your website. When clicked, it opens a WhatsApp chat with a pre-defined message.
## Features
- 🎨 Fully customizable appearance
- 📱 Mobile-friendly and responsive
- 🎯 Multiple position options
- 💬 Custom pre-defined messages
- 🔧 Easy to install and configure
- 🌐 Works with any website
- 💪 No dependencies
- ♿ Accessibility friendly
- 🌙 Dark mode support
- 🖨️ Print-friendly (hides widget)
## Installation
### Using npm
```bash
npm install wa-chat-widget
```
### Using CDN
```html
```
or
```html
```
## Usage
> **Note:**
> The Phone number should be entered in the international format without the `+` sign. For eg: If your number is +1 234-567-9898,
> then you should enter the phone number as `12345679898`.
### ES6 Module
```javascript
import WaChatWidget from 'wa-chat-widget';
const widget = new WaChatWidget({
phoneNumber: '1234567890',
message: "Hello! I'm interested in your services"
});
```
### Script Tag
```html
const widget = new WaChatWidget({
phoneNumber: '1234567890',
message: "Hello! I'm interested in your services"
});
```
## Configuration Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `phoneNumber` | string | `''` | WhatsApp number in international format without + symbol in front (required) |
| `message` | string | `"I'm interested to know more about your offerings."` | Default message |
| `position` | string | `'bottom-right'` | Widget position (`'top-left'`, `'top-right'`, `'bottom-left'`, `'bottom-right'`) |
| `backgroundColor` | string | `'#25D366'` | Background color of the widget |
| `textColor` | string | `'#fff'` | Color of the WhatsApp icon |
| `size` | string | `'60px'` | Size of the widget |
| `showTooltip` | boolean | `true` | Show/hide tooltip on hover |
| `tooltipText` | string | `'Chat with us'` | Text to show in tooltip |
## Examples
### Basic Usage
```javascript
new WaChatWidget({
phoneNumber: '1234567890'
});
```
### Custom Styling
```javascript
new WaChatWidget({
phoneNumber: '1234567890',
backgroundColor: '#075e54',
textColor: '#ffffff',
size: '70px',
position: 'top-right'
});
```
### Multi-Language Support
```javascript
const userLanguage = navigator.language.substring(0, 2);
const messages = {
en: "Hi, I'd like to know more",
es: "Hola, me gustaría saber más",
fr: "Bonjour, j'aimerais en savoir plus"
};
new WaChatWidget({
phoneNumber: '1234567890',
message: messages[userLanguage] || messages.en,
tooltipText: 'Chat with us'
});
```
### Dynamic Control
```javascript
const widget = new WaChatWidget({
phoneNumber: '1234567890'
});
// Hide widget
widget.hide();
// Show widget
widget.show();
// Update options
widget.updateOptions({
backgroundColor: '#128C7E',
size: '65px'
});
// Destroy widget
widget.destroy();
```
### Business Hours
```javascript
function isBusinessHours() {
const now = new Date();
const hours = now.getHours();
const day = now.getDay();
return day >= 1 && day <= 5 && hours >= 9 && hours < 17;
}
new WaChatWidget({
phoneNumber: '1234567890',
message: isBusinessHours()
? "Hi, I'd like to speak with your team"
: "Hi, I'd like to leave a message",
tooltipText: isBusinessHours()
? "Chat with us now!"
: "Leave us a message",
backgroundColor: isBusinessHours() ? '#25D366' : '#128C7E'
});
```
## API Methods
| Method | Description |
|--------|-------------|
| `show()` | Shows the widget |
| `hide()` | Hides the widget |
| `destroy()` | Removes the widget from DOM |
| `updateOptions(options)` | Updates widget configuration |
## Browser Support
- Chrome (Latest)
- Firefox (Latest)
- Safari (Latest)
- Edge (Latest)
- Opera (Latest)
## License
### Commercial license
If you want to use this plugin to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. [Read more about the commercial license.](https://a2plugins.com/wa-chat-widget/#license)
### Open source license
If you are creating an open source application under a license compatible with the GNU GPL license v3, you may use this project under the terms of the GPLv3.
## Author
Raghu Chinnannan
- Website: [https://raghu.ch](https://raghu.ch)
- GitHub: [@raghuchinnannan](https://github.com/raghuchinnannan)
- Twitter: [@raghuchinnannan](https://x.com/raghuchinnannan)
## Support
For support, please open an issue in the [GitHub repository](https://github.com/raghuchinnannan/wa-chat-widget/issues).