0.1.0 • Published 2 years ago
dw-flex-webchat v0.1.0
DW Universal Chat
A package to load DW chat powered by twillio across sites
Local Development
- Export GITLAB_AUTH_TOKEN:
export GITLAB_AUTH_TOKEN=[GITLAB_AUTH_TOKEN].
- Install project dependencies, run:
npm install.
- Run Storybook:
npm run storybook.
Properties
| Option | *Required | Type | Default | Description |
|---|---|---|---|---|
| accountSid | yes | string | "" | Twillio Account SID to initiate the chat |
| flexFlowSid | yes | string | "" | Twillio Flex Flow SID to initiate the chat |
| webchatScript | no | string | "//assets.flex.twilio.com/releases/flex-webchat-ui/2.9.1/twilio-flex-webchat.min.js" | Script file to load twillio web chat |
| applicationName | no | string | "Generic" | Name of the application where the chat is being hosted |
| user | no | object | null | Use Object to initialize configure chat |
User Object
| Option | *Required | Type | Default | Description |
|---|---|---|---|---|
| id | yes | number | null | Unique user identification |
| salutation | no | string | "" | Saludation (Mr., Ms., etc) |
| first_name | no | string | "" | User First Name |
| last_name | no | string | "" | User Last Name |
| avatar | no | string | "" | Users profile picture url |
| emails | no | string | "" | User email |
| username | no | string | "" | User username |
How to publish
To publish your package to npm, make sure you're logged in the correct account by running
npm login.
Update the package version accordingly by using
Finally run:
npm run launch
This will automatically build and publish the project.
To use in a non-react project
Add the following script and html to your project
<div id="dw_wc"></div>
<script type="text/javascript">
window.accountSid = "[TWILLIO_FLEX_ACCOUNT_SID]";
window.flexFlowSid = "[TWILLIO_FLEX_FLOW_SID]";
window.applicationName = "Generic";
</script>
<script crossorigin src="https://unpkg.com/react@17/umd/react.production.min.js"></script>
<script crossorigin src="https://unpkg.com/react-dom@17/umd/react-dom.production.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dw-flex-webchat@latest/dist/cdn.js" defer></script>React and ReactDOM are currently necessary to import but we are trying to have them included as package dependencies and remove these imports in the future.