You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: web-widget/README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,22 @@
1
1
# Channelize JavaScript Widget UI kit
2
-
This is a ready to use UI kit of Channelize chat application.
3
-
It uses [Channelize JS-SDK](https://docs.channelize.io/javascript-sdk-introduction-overview) internally to provide end to end chat support. It provide highly customization in UI as well as functions.
2
+
3
+
This contains the customization capabilities you can achieve by using our JavaScript Sample App created using our [JavaScript SDK](https://docs.channelize.io/javascript-sdk-introduction-overview). This Sample App allows you to add a customized chat widget / docked layout on your website.
4
4
5
5
### Features : ###
6
6
- Highly customization
7
7
- Easy to implement
8
8
- Ready to use
9
9
- Multiple use cases
10
10
11
-
#####You can also check out our demo [here](https://demo.channelize.io).
11
+
#### You can also check out our demo [here](https://demo.channelize.io).
12
12
13
13
## Getting Started
14
14
15
+
Follow the below steps to add Channelize widget / docked layout on your website.
16
+
15
17
##### Step 1: Add widget #####
16
18
17
-
You must add the channelize widget div in the body tag of your website.
19
+
Add the Channelize widget div in the body tag of your website.
18
20
19
21
```html
20
22
<body>
@@ -24,7 +26,7 @@ You must add the channelize widget div in the body tag of your website.
24
26
25
27
##### Step 2: Import Channelize widget file #####
26
28
27
-
Import the `widget.Channelize.js` file after body tag.
29
+
Import the `widget.Channelize.js` file after body tag in your website.
@@ -40,7 +42,7 @@ Import the [`Channelize JS-SDK`](https://docs.channelize.io/javascript-sdk-intro
40
42
41
43
##### Step 4: Create widget object #####
42
44
43
-
Create widget object and call the load function which takes public key as an argument.
45
+
Create widget object and call the load function which will require your public key as an argument.
44
46
45
47
```javascript
46
48
<script>
@@ -50,12 +52,10 @@ Create widget object and call the load function which takes public key as an arg
50
52
```
51
53
52
54
## Customizing the widget
53
-
You can also customize the widget according to your website. We also provide some predefine variables for UI customization, along with this you can also change UI of any content in the code.
54
-
You can create your JS functions and add those in any event listener or function for advanced customization.
55
55
56
-
> Require Node v8.x+ installed.
56
+
> Pre-requisites: Have Node v8.x+ installed.
57
57
58
-
1. Update Channelize widget file URL in index.html file.
58
+
1. Update Channelize widget file URL in your index.html file.
- Customize the UI of widget / docked layout as per your choice by changing the values of predefined variables in `./web-widget/src/scss/variables.scss file` or by making changes in the code of the elements/content.
79
81
80
-
1. We have defined some variables to modify colours and position of main UI contents. So you can change those values in ./web-widget/src/scss/variables.scss file.
81
82
82
-
2. You can also update the UI of any content by changing in their code.
83
+
###### For Function Customizations : ######
83
84
84
-
###### Function Customization : ######
85
+
- Add your functions or make code-level changes.
85
86
86
-
1. You can add your functions or can make code level changes in functions.
87
87
88
+
## Advanced
88
89
89
-
## Advanced
90
90
### Change the application :
91
91
If you want to change your current application, you just need to change the `PUBLIC_KEY` in `index.html` file.
92
92
@@ -152,7 +152,7 @@ If you want to load conversation window, then you can use `loadConversationWindo
152
152
|-- login.js - login class
153
153
|-- recent-conversation.js - recent conversation class
0 commit comments