Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlosulisesochoa/react-whatsapp-floating-button
Simple React Component for adding a floating WhatsApp button to your project.
https://github.com/carlosulisesochoa/react-whatsapp-floating-button
button floating react typescript vite whatsapp
Last synced: 27 days ago
JSON representation
Simple React Component for adding a floating WhatsApp button to your project.
- Host: GitHub
- URL: https://github.com/carlosulisesochoa/react-whatsapp-floating-button
- Owner: CarlosUlisesOchoa
- License: mit
- Created: 2024-02-10T20:56:32.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T17:32:55.000Z (about 1 month ago)
- Last Synced: 2024-10-12T22:04:43.769Z (27 days ago)
- Topics: button, floating, react, typescript, vite, whatsapp
- Language: TypeScript
- Homepage:
- Size: 446 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ⚛️⚡ WhatsApp Floating Button Component for React
## Description
This React component offers an elegant WhatsApp floating button, serving as a bridge to the official WhatsApp application. It simulates a WhatsApp chat interface, allowing users to initiate conversations directly from your website. Upon clicking "submit," users are redirected to WhatsApp with their message pre-filled, ready to continue the conversation. Ideal for enhancing customer support and engagement, this component simplifies the transition from web inquiries to WhatsApp communication using WhatsApp's API.
## Screenshots
The WhatsApp Floating Button Component supports both light and dark modes, ensuring it can integrate seamlessly with your application's theme. Below are the mockups for each mode:
| Light Mode | Dark Mode |
|:----------:|:---------:|
|  |  |
Toggle between the modes to provide a consistent user experience regardless of your app's theme.
## Installation
Install the component using your preferred package manager:
### npm
```bash
npm install @carlos8a/react-whatsapp-floating-button
```
### pnpm
```bash
pnpm install @carlos8a/react-whatsapp-floating-button
```
### Yarn
```bash
yarn add @carlos8a/react-whatsapp-floating-button
```
## Usage Example
Below is a basic example demonstrating how to integrate the WhatsApp floating button into your app:
```jsx
import { FloatingWhatsApp } from '@carlos8a/react-whatsapp-floating-button';
const App = () => {
return (
);
};
export default App;
```
### Available Props
| Prop | Type | Required | Description | Default |
|---------------------------|:---------------------:|:--------:|--------------------------------------------------------------------------------------------------------------------------|----------------------------------|
| `phoneNumber` | String | Yes | Phone number in [international format](https://faq.whatsapp.com/general/contacts/how-to-add-an-international-phone-number)| `5215540000000` |
| `accountName` | String | No | Account username | `Account Name` |
| `onClick` | Function | No | Callback fired on click | `-` |
| `onSubmit` | Function | No | Callback fired on submit with the event passed | `-` |
| `onClose` | Function | No | Callback fired on close | `-` |
| `onLoopDone` | Function | No | Callback called when notification loop is done | `-` |
| `onNotification` | Function | No | Callback fired when a notification is triggered | `-` |
| `avatar` | String | No | Path to change user avatar using [static assets](https://create-react-app.dev/docs/adding-images-fonts-and-files/) | `UI Face` |
| `statusMessage` | String | No | Text displayed below the account username | `Typically replies within 1 hour`|
| `initialMessageByServer` | String | No | First message visitors receive | `Hello there! How can we help?` |
| `initialMessageByClient` | String | No | Message that the user will send to your WhatsApp | `Hello!, I got your contact from your website. I would like to chat with you about...` |
| `startChatText` | String | No | Text displayed inside the "Start Chat" button | `Start chat with us` |
| `tooltipText` | String \| `null` | No | Text that will appear in the tooltip, adjacent to the WhatsApp button | `null` |
| `messageDelay` | Number | No | Delay before displaying `initialMessageByServer` (seconds) | `2` |
| `notification` | Boolean | No | Enables notifications (disabled after user opens the chat box) | `false` |
| `notificationDelay` | Number | No | Delay between notifications (seconds) | `60` |
| `notificationLoop` | Number | No | Number of times notifications loop | `0` |
| `notificationStyle` | CSSProperties | No | Inline style for notification | `{}` |
| `notificationClassName` | String | No | CSS class for notification indicator | `floating-whatsapp-notification` |
| `allowClickAway` | Boolean | No | Allows chat box to close when clicking outside | `false` |
| `allowEsc` | Boolean | No | Allows chat box to close when pressing `Escape` key | `false` |
| `darkMode` | Boolean | No | Enables dark style | `false` |
| `className` | String | No | CSS class for the main wrapping `Div` | `floating-whatsapp` |
| `buttonClassName` | String | No | CSS class for the button | `floating-whatsapp-button` |
| `style` | CSSProperties | No | Inline style for the main wrapping `Div` | `{}` |
| `buttonStyle` | CSSProperties | No | Inline style for the button | `{}` |
| `chatboxHeight` | Number | No | Chat box height | `320` |
| `chatboxClassName` | String | No | CSS class for the chat box | `floating-whatsapp-chatbox` |
| `chatboxStyle` | CSSProperties | No | Inline style for the chat box | `{}` |
### Development and Testing Files
The following files are intended solely for development and testing purposes and do not form part of the component's distribution:
- `/index.html` (used to test the component)
- `/src/**/*` (excluding `/src/lib/**/*` which is the component)
- `/public/` (used to test the component)
- `/preparePublish.js` (prepares the component for npm publishing)
## Building and Testing the Package
**Note**: For anyone that just want to get and use the component, the [Installation](#installation) and [Usage Example](#usage-example) sections have got all you need 👍🏻.
This section is for developers who want to modify the component. Follow the steps outlined below to rebuild and test your changes locally.
### Prerequisites
Make sure you have Node.js (version 18 or higher) installed on your system. This project employs `pnpm` for efficient dependency management. If you don't have `pnpm`, install it with the following command:
```bash
npm install -g pnpm
```
### Setting Up the Development Environment
1. **Clone the Repository**: Get a copy of the project onto your local machine by cloning the GitHub repository.
```bash
git clone https://github.com/CarlosUlisesOchoa/react-whatsapp-floating-button.git
cd react-whatsapp-floating-button
```
2. **Install Dependencies**: Use `pnpm` to install all the necessary dependencies. This ensures your environment is equipped with everything needed for building and testing the component.
```bash
pnpm install
```
### Running a Local Development Server
You will be able to modify and see real-time changes due we are using Vite to dev and deploy.
You can run:
```bash
pnpm run dev
```
Now you will be able to start enhancing or customizing this beautiful but always improveable component 😁.
### Rebuilding the Library
Execute the following command to build the library:
```bash
pnpm run build:lib
```
This script performs a series of tasks:
- Clears the `dist` directory for a clean build.
- Adjusts TypeScript configurations for the build.
- Compiles the library using Vite into the `dist` folder, which will contain the production-ready code.
- Resets TypeScript configurations after the build.
That's it. Now you can take a look at the ```dist``` directory where you'll find the bundled code.
## Acknowledgements
- Special thanks to [@awran5](https://github.com/awran5) for the [react-floating-whatsapp](https://github.com/awran5/react-floating-whatsapp) component, which served as a base for this enhanced version.
- Gratitude to [@darwinva97](https://github.com/darwinva97) for the [PR](https://github.com/awran5/react-floating-whatsapp/pull/27) contributing improvements in accessibility and SEO through `aria-hidden` attribute modifications.
### License
[MIT License](LICENSE) © 2024