https://github.com/appquick/ngx-addchat
A open source library to add instance message shortcut to your website by Appquick.co
https://github.com/appquick/ngx-addchat
Last synced: about 1 year ago
JSON representation
A open source library to add instance message shortcut to your website by Appquick.co
- Host: GitHub
- URL: https://github.com/appquick/ngx-addchat
- Owner: AppQuick
- License: mit
- Created: 2018-02-28T08:00:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-02T10:38:59.000Z (about 7 years ago)
- Last Synced: 2025-02-17T04:05:29.000Z (about 1 year ago)
- Language: CSS
- Homepage: https://appquick.co/
- Size: 855 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ngx-addchat
Adding instance message shortcut to your website.
Now supported platform:
1. Whatsapp
2. Facebook Messenger
## Getting Started
### Installation
1. Install using npm:
```bash
npm install ngx-addchat --save
```
2. Import `NgxAddchatModule` to your `app.module.ts`.
```typescript
import { NgxAddchatModule } from 'ngx-addchat'; // <-- Add this
...
@NgModule({
imports: [
NgxAddchatModule // <-- And this
],
...
})
```
3. Add element to the end of HTML (e.g. `app.component.html`)
```html
...
```
## Configuration
### Whatsapp
```
whatsapp=""
```
Insert `whatsapp` into ``.
**_Example_**
```html
```
`852` is the country code of Hong Kong, and `5573 7471` is the phone number we want.
### Facebook
```
fbPageName=""
```
Insert `fbPageName` into the ``
**_Example_**
```html
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Credit
**Inspired by [whatshelp]**
The original idea is from [whatshelp], which is providing a snippet which is including cross-site scripting (XSS). It may encounter some potential security issues. For more information, please check in [Angular.io/security](https://angular.io/guide/security#xss).
**Tools using in this project**
- [ionicons v2.0.1](http://ionicons.com/)
- [Facebook plugin](https://developers.facebook.com/docs/plugins/page-plugin)
## Roadmap
- Improve [Facebook Messenger plugin](https://developers.facebook.com/docs/messenger-platform/discovery/customer-chat-plugin)
- Adding more popular IM platforms
- Adding and customising the pop-out animations
- Customising the color of bubbles
## Limitation
This library is only tested on [Angular.io v5.0.0](https://angular.io).
[whatshelp]: https://whatshelp.io/widget