abb-feedback-module
v3.4.8
Published
Feedback components
Downloads
195
Readme
Table of contents
Quick start
Several quick start options are available:
- Install with npm:
npm install abb-feedback-module
- Install with yarn:
yarn add abb-feedback-module
- Install with Composer:
composer require twbs/abb-feedback-module
- Install with NuGet: CSS:
Install-Package bootstrap
Sass:Install-Package abb-feedback-module.sass
Status
What's included
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
abb-feedback-module/
└── dist/
|── components/
| ├── styles/
| | ├── bot.scss
| | ├── chat.scss
| ├── Bot.js
| ├── Chat.js
| ├── Screenshot.js
└── constants/
├── constants.js
├── Chat.js
├── Screenshot.js
Documentation
How to install
npm install abb-feedback-module
Or
yarn add abb-feedback-module
Comapatibility and Dev Dependencies.
Supported versions of react and react dom :
react :"^16.14.0"
react-dom : "^16.14.0"
External Libraries:
"@abb/abb-common-ux-react": "^0.24.1".
Note to be followed for external libraries:
We need to add .npmrc file in the root directory. In the file add the registry and its permissions to access it with in the project.
How it works
import { Bot } from 'abb-feedback-module';
<Bot
/* globalLanguage is used only when you want your application to be translated in multiple languages*/
globalLanguage={"English - ENG"}
/* This is the Url you need to provide to send your feedback and get it saved in backend database */
submitFeedbackUrl={"https://dev.url.submitfeedback.com"} /*example url*/
/* This is the Url you need to provide to get the logged in user's email id */
userProfileEndpoint={"https://dev.url.userendpoint.com"} /*example url*/
/* This is the token that you need to pass for the authentication */
bearerToken={"Eyklsfdf7868klmdfkjkjkdfdsjfhk7868sdfjkjHKlkldjfksdjkjkj"} /*example token*/
/* It is the logged in user's organization GUID */
organizationGUID={"G1234567890"} /*example GUID*/
/* This is a boolean value which decides whether you want to hide or display chat */
hideChat={false}
/>
Props 💬
| Prop | Type | Default | Description | Possible Values |
|:--------- | :---- | :---- |:---- |:---- |
| globalLanguage
| string
| English - ENG
| Language that user wants to get it displayed in | "English - ENG" for English "Mandarin - MAD" for Mandarin "Spanish - SPAN" for Spanish "Italiana - ITAL" for Italian "Tedesca - GER" for German "francese - FRE" for French "finlandese - FIN" for Finnish "Russa - RUS" for Russian "portoghese - PORT" for Portugese
| organizationGUID
| string
| | It is the logged in user's organization GUID
| `submitFeedbackUrl` | `url` |
| This is the Url you need to provide inorder to send your feedback to get it saved in backend database
| userProfileEndpoint
| url
| | This is the Url you need to provide inorder to get the logged in user's email id
| `bearerToken` | `string` |
| This is the token you need to pass for the authentication
| hideChat
| boolean
| false | This is a boolean value which decides whether you can hide or display chat
Contact us
global-support.northstar@abb.com