https://github.com/chihebnabil/dc-chat-widget
easy-to-use chat widget for your web applications
https://github.com/chihebnabil/dc-chat-widget
Last synced: 3 months ago
JSON representation
easy-to-use chat widget for your web applications
- Host: GitHub
- URL: https://github.com/chihebnabil/dc-chat-widget
- Owner: chihebnabil
- Created: 2024-05-16T14:15:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-21T14:00:11.000Z (about 1 year ago)
- Last Synced: 2025-02-20T21:47:33.826Z (4 months ago)
- Language: Vue
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DocsChatAI Chat Widget
`dc-chat-widget` is a and easy-to-use chat widget for your web applications.
[Watch the video](https://www.loom.com/embed/0e18a9d4d47c4446bb77e0f34c3fb4e3?sid=f25e5121-1ec5-4c18-ad15-db42275b4733)
## Before you start
Before you start using the chat widget, you need to:
- Create an account on [DocsChatAI.com](https://docschatai.com)
- Upload at least one file the workspace (Folder)
- Copy the workspace (Folder) ID from [this page](https://docschatai.com/workspaces) by clicking on the three dots on the right side of the workspace (Folder) and selecting `Copy ID`.
## Installation
Install the package via npm:
```sh
npm install dc-chat-widget
```
or Using unpkg CDN:
```html
```
## Usage
```javascript
import "dc-chat-widget";
```
Then add the following tag to your HTML:
```html
```
## Configuration
You can configure the chat widget by passing the following attributes:
- `workspace-id`: The workspace (Folder) ID of your chatbot (DocsChatAI.com).
- `title`: The title of the chat widget.
- `subtitle`: The subtitle of the chat widget.
- `theme`: The hex color code of the chat widget.
- `btn-size`: The size of the chat widget button. Default is `50px`.
- `btn-bottom`: The bottom position of the chat widget button. Default is `10px`.
- `btn-right`: The right position of the chat widget button. Default is `10px`.
- `font-family`: The font family of the chat widget. Default is `Arial, Helvetica, sans-serif`.
- `actions`: quick actions to be displayed in the chat widget. Default is `[]`.
```html
```
## Constributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.