NgxTourGuide

Angular module providing a framework for creating guided tours in your application.

This module emphasises on defining multiple tours throughout your application.

Demo

Demo page

Installation

yarn

yarn add @shipbit/ngx-tour-guide

npm

npm i --save @shipbit/ngx-tour-guide

Angular CDK

The package is dependant on Angular CDK overlay make sure to inlcude the prebuilt css if you are not already using angular material themes.

The package uses Angular animations for disabling these (e.g. testing) import the NoopAnimationsModule

Usage

Simple setup

1. Add the module and either BrowserAnimationsModule or NoopAnimationsModule

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";
import { NgxTourGuideModule } from "@shipbit/ngx-tour-guide";

import { AppComponent } from "./app.component";

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    NgxTourGuideModule.forRoot(),
  ],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

2. Add the shipbit-ngx-tour-guide to your app root

app.component.html

<shipbit-ngx-tour-guide> </shipbit-ngx-tour-guide>

3. Start your tour

import { Component } from "@angular/core";
import { NgxTourGuideService } from "@shipbit/ngx-tour-guide";

@Component({
  selector: "showcase-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent {
  title = "showcase";

  constructor(tourGuideService: NgxTourGuideService) {
    tourGuideService.start({
      stops: [
        {
          element: ".toolbar",
          title: "This is a Toolbar!",
          content: "This is the default toolbar created with Angular CLI",
        },
        {
          element: ".content",
          title: "This is the Content!",
          content: "This is the default content created with Angular CLI",
        },
        {
          element: ".card-container",
          title: "Find resources here",
          content:
            "These are resources helping you to get started with angular development.",
        },
      ],
    });
  }
}

Register tours for later use

register a tour

    const tour: TourGuide =  {
        ...
    }

    tourGuideService.register(tour, 'HowToUpgradeTour');

and start it any time

tourGuideService.start("HowToUpgradeTour");

Use Templates for content

component.html

<ng-template #customTourStop let-content>
  <div>
    <img [src]="content.image" />
    <p>...</p>
  </div>
</ng-template>

component.ts

@ViewChild('customTourStop') customTourStop: TemplateRef<unknown>

...

public startTour(model: WorkflowItem){
    tourGuideService.start({
        stops: [
            {
            element: " button[submit] ",
            title: "Here you can submit",
            content: model,
            contentTemplate: this.customTourStop,
            },
        ],
    });
}

Use html content (make sure to sanitize)

component.ts

public startTour(model: WorkflowItem){
    tourGuideService.start({
        stops: [
            {
            element: "#detailArea",
            title: "This is the detail area",
            content: "This is <strong>html</strong> for templateless text styling.<br> Make sure to sanitize your html if it originates from <em>untrusted sources</em>",
            },
        ],
    });
}

Customize Actions

YOu can provide content for any action button, in this case material icons

<shipbit-ngx-tour-guide>
  <span class="material-icons md-18" ngxTourGuidePreviousContent
    >arrow_back</span
  >
  <span class="material-icons md-18" ngxTourGuideNextContent
    >arrow_forward</span
  >
  <span class="material-icons md-18" ngxTourGuideFinishContent>check</span>
  <span class="material-icons md-18" ngxTourGuideSkipContent>close</span>
</shipbit-ngx-tour-guide>

You can configure actions for each tour

const tourGuide: TourGuide = {
    stops:[...]
    actions: {
        finishTour: {
          label: 'Abschließen',
          onExecute: (stop, action) => {
            if (someReason) {
              action.cancel = true;
            }
          },
        },
        previousStop: { label: 'Zurück' },
        nextStop: { label: 'Weiter' },
        skipTour: { hidden: true },
      }
}

Customize Stops

You can also use user interactions as actions

const tourGuide: TourGuide = {
  stops: [
    {
      contentTemplate: openMenuTemplate,
      element: ".menu-open-button",
      title: "This is the main menu",
      action: {
        replacesNextOrFinish: true,
        event: "click",
        delay: 200,
      },
    },
    {
      content: 'You can navigate to any menu page by clicking the item'
      element: ".menu-list",
      title: "Menu entries",
      action: {
        replacesNextOrFinish: true,
        event: "mouseenter",
        delay: 500,
      },
    },
  ],
};

Styling

The base comes without any color information besides the overlay background.

css variables

These variables can be used to configure the overlay

| variable | default | description | | -------------------------------------------- | ------------------------- | ------------------------------------------------------- | | --ngx-tour-guid__z-index | 1000 | The zindex the tour guide overlay will have in your app | | --ngx-tour-guide__overlay-backdrop-filter | blur(200px) | The filter the overlay uses on the background | | --ngx-tour-guide__overlay-background-color | rgba(255, 255, 255, 0.15) | The color of the overlay |

css classes

These classes can be used to directly style the corresponding element | selector | description | |---|---| |.tour-guide-container| targets the container of the skip button (if used) as well as every stop message | |.tour-guide--skip|targets the container of the skip button specificly| |.tour-guide--overlay|targets the overlay over your app| |.tour-guide-stop| targets the layout of a stop: grid layout | |.tour-guide-stop.stop-title|targets the title of a stop| |.tour-guide-stop.stop-content|targets the content of a stop| |.tour-guide-stop.stop-counter|targets the counter of a stop|