boardme v0.1.10

boardme

A client side library for using the boardme API (types included).

boardme is a user onboarding SaaS that integrates seamlessly with any website or application. It helps users learn how an app works and guides them to immediate value. It is a plug-and-play solution and it doesn't require technical skills to operate. As long as you are technical enough to copy and paste, you are qualified to create and run user onboarding Flows on your website.

Check out the documentation for more information!

Installation

With npm

npm install boardme --save

With yarn

yarn add boardme

With bower

bower install boardme --save

Usage

Javascript

var boardme = require("boardme");

var guide =  boardme.renderGuide( "guide-identifier" );

// Event listeners

guide.onSubmit(function() {
  console.log( "Guide has been submitted" );
});

guide.onSubmit(function() {
  console.log( "Guide has been dismissed" );
});

TypeScript

As library

import * as boardme from "boardme";

const guide = boardme.renderGuide( "guide-identifier" );

// Event listeners

guide.onSubmit( () => console.log( "Guide has been submitted" ) );

guide.onDismiss( () => console.log( "Guide has been dismissed" ) );

As utility function

import { renderGuide } from "boardme";

const guide = renderGuide( "guide-guid" );

// Event listeners

guide.onSubmit( () => console.log( "Guide has been submitted" ) );

guide.onDismiss( () => console.log( "Guide has been dismissed" ) );

AMD

define(function(require,exports,module){
  var boardme = require('boardme');
});