Angular Directive To Build Web App Tours Library | ngx-joyride

Angular Tour (Joyride) library is built entirely in Angular, without using any heavy external dependencies like Bootstrap or JQuery. From now on, you can easily guide users through your site and show them all the sections and features.

bootstrap guided tour, ngx guided tour example, website guided tour plugin, ngx ui tour core, javascript guided tour library, website tour examples, javascript product tour libraries

A Plugin for Bootstrap 5 That Allows Building Intro Tours

How to make use of it:


npm install ngx-joyride --save
yarn add ngx-joyride

1. Mark your HTML elements with the joyrideStep directive.

<h1 joyrideStep="firstStep" title="Page Title" text="Main title!">Text</h1>
<div joyrideStep="secondStep" title="Page Title" text="Main title!">Div content</div>

2. Import the JoyrideModule in your AppModule.

    declarations: [AppComponent],
    imports: [JoyrideModule.forRoot(), RouterModule.forRoot([]), BrowserModule],
    providers: [],
    bootstrap: [AppComponent],
export class AppModule {}

3. Inject the JoyrideService in your Component and start the Tour, passing the steps order list.

    selector: 'app-component',
    templateUrl: './app.component.html',
export class AppComponent {
    constructor(private readonly joyrideService: JoyrideService) {}

    onClick() {
            { steps: ['firstStep', 'secondStep'] } // Your steps order

API reference

Directive Inputs/Outputs

You can use theĀ joyrideStep a directive with these inputs:

joyrideStepYesThe step name should be unique.string
stepPositionNoThe position in which the step will be drawn.‘top’, ‘right’, ‘bottom’, ‘left’, ‘center’
titleNoThe step title.string
textNoThe step text content.string
stepContentNoAn Angular template with custom content.TemplateRef<any>
stepContentParamsNoData object to pass in with Angular templateObject
prevTemplateNoAn Angular template with a custom prev button.TemplateRef<any>
nextTemplateNoAn Angular template with a custom next button.TemplateRef<any>
doneTemplateNoAn Angular template with a custom-done button.TemplateRef<any>
counterTemplateNoAn Angular template with a custom counter component.TemplateRef<any>
nextNoIt fires an event when ‘Next’ button is clicked.
prevNoIt fires an event when ‘Prev’ button is clicked.
doneNoIt fires an event when ‘Done’ button or ‘Close’ are clicked and the Tour is finished.

Directive To Build Web App Tours, Angular Joyride Plugin/Github

See Demo And Download

Official Website(tnicola): Click Here

This superior jQuery/javascript plugin is developed by tnicola. For extra advanced usage, please go to the official website.

Related Posts


Responsive Image Gallery Lightbox jQuery Plugin | VenoBox

VenoBox is a responsive jQuery modal window plugin suitable for images, embedded content, iFrames, Google Maps, Vimeo, and YouTube videos. The big difference compared to many other…


[Animation] Bootstrap Multi-Level Responsive Dropdown Menu

Bootstrap-based multi-level dropdown navigation menu with cool animations. The dropdown on Hover is a jQuery plugin used to create Bootstrap multi-level scroll-triggered dropdown menus with CSS3 animations…


Google Translate Dropdown Customize With Country Flag | GT API

Flag google translates jQuery text that takes advantage of the Google Cloud Translation API to translate web content between languages by selecting a country from the dropdown…


HTML 5 File Input Optimized for Bootstrap 4.x./3.x with File Preview | Bootstrap Fileinput

bootstrap-fileinput is an improved HTML 5 file input  Bootstrap 5.x, 4.x and 3.x with file preview for different files, provides multiple selections, resumable section uploads, and more….


CSS Layout Components Horizontal/Vertical Stack | HStack and VStack

HStack and VStack in CSS – CSS layout components that (basically) stack anything horizontally and vertically. A pure CSS library that makes it easy to stack elements…


How to Add Floating Whatsapp Chat Button In HTML | venom-button

Venom Button is a very simple plugin for the jQuery floating WhatsApp button. Adds a floating button to your site that calls WhatsApp Click to Chat API. It will automatically start the WhatsApp…

Leave a Reply

Your email address will not be published. Required fields are marked *