sariska-cobrowsing
v1.2.1
Published
Sariska coBrowsing SDK
Downloads
10
Readme
Sariska Co-Browsing SDK
Sariska Webapp or Co-Browsing SDK creates a co-browsing experience for any web page with a 95% smaller payload than screen sharing, allowing for multiple cursors. Co-browsing annotates both parties' cursors as you navigate the website together with your team
Requirements
For development, you will only need Node.js and npm, installed in your environement.
Integrating the SDK into any website
Using npm
$ npm i sariska-cobrowsing
Using Yarn
$ yarn add sariska-cobrowsing
If you are facing dependency conflict related issues, add --legacy-peer-deps as follows:
$ npm i sariska-cobrowsing --legacy-peer-deps
Import SDK
To import the SDK, add the following command to your code.
$ import {coBrowsing} from 'sariska-cobrowsing';
Start CoBrowsing
In order to start co-browsing, call its startCoBrowsing method as shown below.
$ coBrowsing.startCoBrowsing("username", "sessionname");
Stop CoBrowsing
In order to stop co-browsing, call its stopCoBrowsing method as shown below.
$ coBrowsing.stopCoBrowsing();
Instructions on how to integrate Sariska's Co-Browsing SDK into any react project or html page can be found at https://docs.sariska.io/co-browsing/javascript