codoozer-tour v0.0.33

Codoozer Tour

Getting started

1. Go to codoozer.com and create a tour project.
2. Create all your tours and the steps of each tour.
3. Publish your tour to get the url you need to init your codoozer-tour lib.
4. Import codoozer-tour in your code with npm or cdn.
5. Start a tour whenever you want with the id of the tour.

Install

npm

import CodoozerTour from 'codoozer-tour';
import 'codoozer-tour/build/index.css' // If you import a css file in your library
...

cdn

<link href="https://unpkg.com/codoozer-tour/build/index.css" rel="stylesheet">
<script src="https://unpkg.com/codoozer-tour/build/index.js"></script>
...

Usage

npm

let tour = new CodoozerTour({ hash: 'HASH' });
...

cdn

let CodoozerTour = window.CodoozerTour.default;
let tour = new CodoozerTour({ hash: 'HASH' });
...

tour.start('main_tour')

API

start(tourId)

• tourId: must be a String that represents the id of the tour you want to start.