Skip to content

Commit e3e9f8c

Browse files
Update docs
1 parent 49563c0 commit e3e9f8c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

web-widget/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
# 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.
44

55
### Features : ###
66
- Highly customization
77
- Easy to implement
88
- Ready to use
99
- Multiple use cases
1010

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).
1212

1313
## Getting Started
1414

15+
Follow the below steps to add Channelize widget / docked layout on your website.
16+
1517
##### Step 1: Add widget #####
1618

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.
1820

1921
```html
2022
<body>
@@ -24,7 +26,7 @@ You must add the channelize widget div in the body tag of your website.
2426

2527
##### Step 2: Import Channelize widget file #####
2628

27-
Import the `widget.Channelize.js` file after body tag.
29+
Import the `widget.Channelize.js` file after body tag in your website.
2830

2931
```javascript
3032
<script src="https://cdn.channelize.io/apps/web-widget/1.0.0/widget.Channelize.js"></script>
@@ -40,7 +42,7 @@ Import the [`Channelize JS-SDK`](https://docs.channelize.io/javascript-sdk-intro
4042

4143
##### Step 4: Create widget object #####
4244

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.
4446

4547
```javascript
4648
<script>
@@ -50,12 +52,10 @@ Create widget object and call the load function which takes public key as an arg
5052
```
5153

5254
## 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.
5555

56-
> Require Node v8.x+ installed.
56+
> Pre-requisites: Have Node v8.x+ installed.
5757
58-
1. Update Channelize widget file URL in index.html file.
58+
1. Update Channelize widget file URL in your index.html file.
5959
```javascript
6060
<script src="./dist/widget.Channelize.js"></script>
6161
```
@@ -75,18 +75,18 @@ npm run build
7575
npm start
7676
```
7777

78-
###### UI Customization : ######
78+
###### For UI Customizations : ######
79+
80+
- 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.
7981

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.
8182

82-
2. You can also update the UI of any content by changing in their code.
83+
###### For Function Customizations : ######
8384

84-
###### Function Customization : ######
85+
- Add your functions or make code-level changes.
8586

86-
1. You can add your functions or can make code level changes in functions.
8787

88+
## Advanced
8889

89-
## Advanced
9090
### Change the application :
9191
If you want to change your current application, you just need to change the `PUBLIC_KEY` in `index.html` file.
9292

@@ -152,7 +152,7 @@ If you want to load conversation window, then you can use `loadConversationWindo
152152
|-- login.js - login class
153153
|-- recent-conversation.js - recent conversation class
154154
|-- search.js - search class
155-
|-- adapter.js - channelize JS SDK functions
155+
|-- adapter.js - Channelize JS SDK functions
156156
|-- constants.js - const variables
157157
|-- utility.js - utility functions
158158
|-- widget.js - widget main functions

0 commit comments

Comments
 (0)