README.md

angular-walkme

An AngularJS module for interfacing with the WalkMe snippet API

Table of Contents

• Background
• Install
• Usage
• License

Background

Install

npm install @buildium/angular-walkme --save

Usage

angular.module('MyApp', ['buildium.angular-walkme'])

.config(function(AngularWalkMeProvider) {
    AngularWalkMeProvider.setEditorSnippetUrl('https://snippet/url')
})

.run(function(AngularWalkMe) {
    AngularWalkMe.addVariables(walkMeVariables);
    AngularWalkMe.runSnippet();
    AngularWalkMe.onWalkthroughCompleted(onWalkthroughCompleted);
})

License

MIT © Buildium