tovaz-tour

This is a component to create easy and functional Guide Tours.

Usage no npm install needed!

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

README

Tovaz Guide Tour

This library was generated with Angular CLI version 12.0.5.

To install use

npm install tovaz-tour

Import the module in your app.module

import { TovazTourModule } from 'projects/tovaz-tour/src/public-api';

How to create a tour

You have to use the service called TovazService

The service receive an array of StepOptions and return an observable which is called everytime that new step is displayed.

this.tourService.start( steps ).subscribe( (step:any) => {
  console.log('CURRENT STEP', step);
});

Step and Tour Interfaces

export interface TourOptions {
  name, 
  skipped?: false, 
  ended?: false
}
  
export interface StepOptions {
  dom,      
  title, 
  content,  
  image?, 
  tour?,
  position?, 
  delay?, 
  isStart?
}

Dont forget to add in app.component.html the component tag

<tovaz-tour></tovaz-tour>