simple-tour

Just a tour. Promise based simple JavaScript Tour.

Usage no npm install needed!

<script type="module">
  import simpleTour from 'https://cdn.skypack.dev/simple-tour';
</script>

README

Simple Tour

Just a tour. Primises based simple JavaScript Tour.

How to use

You need to have any kind of Promise object in window scope. For example you can add or use your dependency management tool to add it.

<script src="//cdn.jsdelivr.net/bluebird/3.4.5/bluebird.min.js"></script>

Simple JavaScript, no dependency management

  //<script type="text/javascript" src="../dist/simple-tour.js"></script>

  window.simpleTour.start([
    {
      url: '/demo/#test',
      element: '.at-cls-1',
      position: 'bottom',
      text: 'Text 1',
      event: 'click'
    },
    {
      url: '/demo/#test2',
      element: '.at-cls-1',
      position: 'bottom',
      text: 'Text 2',
      event: 'click'
    },
    {
      url: /\/demo\/\#.+$/i,
      element: '.at-cls-2',
      position: 'bottom',
      text: 'Text 3',
      event: 'click'
    }
  ]);

Webpack, browserify

import simpleTour from 'simpleTour';

simpleTour.start([...]);

Require.js

//config.js
paths: {
  'simpleTour': '<path-to-node_modules>/node_modules/simple-tour/dist/simple-tour'
}

//my-file.js
define((require) => {
  var simpleTour = require('simpleTour');

  simpleTour.start([...]);
});