A chat widget based on and utilizing SendBird.
npm install onshift-chat-widgetA chat widget designed to be used in both mobile and non-mobile environments.
Utilizing Sendbird and the SDK they provide, this widget will
allow for conversational communication between the various members of a given Engage
community.
- Clone the repo
- run npm install
- run npm run start-dev
- this will start the chat widget on localhost:9000
``
import SendBirdWidget from 'onshift-chat-widget/build/widget.Sendbird.js';
let sbWidget = new SendBirdWidget();
``
- in order to initialize the widget, a div with an id of sb_widget must exist somewhere in the DOM`
- create a json object, similar to the below:`
var loginData = {
appId:'XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX',
nickname: 'Nickname Goes Here',
role: 'Administrator',
userId: 'Unique ID of user goes here'
};
- appId: the id of the Sendbird application we are connecting to
- userId: the id of the user who is connecting to the Sendbird application
- nickname: the name to be displayed when displaying their name
- accessToken: some valid access token that
- in order to start the widget, invoke the widget and pass in the loginData json object you created: sbWidget.startWithConnect(loginData)
We are going to use the jest test running framework, as that seems to be
the framework that newer OnShift components are migrating to. To run the tests, simply run npm run test`.