Ovh-angular-chatbot NPM

ovh-angular-chatbot

githubbanner

Maintenance

the ovh-chatbot component for web integration

Installation

npm

npm install --save ovh-angular-chatbot

bower

not supported

Configuration

:warning: You have to compile the less by yourself :warning:

In your index.html:

<!-- ovh-angular-chatbot -->
<script src="dist/ovh-angular-chatbot.min.js"></script>

<!-- place it anywhere (if you want to use the default) -->
<chatbot></chatbot>


<!-- place it anywhere (if you want to configure the pull rate) -->
<chatbot pull="2" ></chatbot>

In you app.js:

    ...
    angular.module("myApp", [..., "ovh-angular-chatbot", ...]);
    ...

    //if you want to use a custom url:

    angular.module("myApp").config(["chatbotServiceProvider", function(chatbotServiceProvider) {
        chatbotServiceProvider.setChatbotUrl("you.re/url/here");
    }]);

The notifications have the icon of the file located at : '/img/ovh-angular-chatbot.png'.

dependencies

You will need to have installed:

angular : ^1.6.1
angular-animate : ^1.4.0
angular-web-notification : ^1.2.22
jquery-ui : ^1.12.1
ng-embed : ^2.2.0
ovh-ui-kit : ^1.0.0
ovh-angular-user-pref : ^0.3.1

Caution: this dependencies are installed as node_modules not bower_components.

Get the sources

   git clone https://github.com/ovh-ux/ovh-angular-chatbot.git
   cd ovh-angular-chatbot
   npm install

You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!

Have a look in CONTRIBUTING.md

Documentation

the chatbot div is automatically placed in the bottom right of the page.

Disclaimer

the parent container must at least be 100vw x 100vh for the draggable feature to work properly.

ovh-angular-user-pref:

Key used: CHATBOT_PREF

property	type	default	usage
enable	bool	true	is the chatbot enabled or not?
notifications	bool	false	will there be notifications, when the user gets a message, when the chatbot is minimized

You can use:

grunt : to build.
grunt lint : to run eslint
grunt watch : will rebuild your project when a file change. Also re-launch Karma when a spec file change.
grunt test : to test specs files with Karma/Jasmine.
grunt release --type=major|minor|patch : to release your module.