Skip to content

hakimio/ngx-ui-tour

Repository files navigation

Ngx UI Tour

UI tour library for Angular

Angular Material, Ionic, Taiga UI, Ng Bootstrap and Ngx Bootstrap UIs are supported.

ngx-ui-tour is a fork of Isaac Mann's ngx-tour. The project had to be forked since the original is no longer maintained.


npm npm npm

Table of contents

Demo and documentation

Demo and documentation can be found at hakimio.github.io/ngx-ui-tour

Compatibility

Material Design and Ngx Bootstrap tour UIs

Angular RxJS ngx-ui-tour
18 7 13
17 7 12
16 7 11
15 7 10
14 6, 7 9
12-13 6, 7 8
9-12 6 7

NG Bootstrap tour UI

Angular RxJS ngx-ui-tour
18 7 15
17 7 14
16 7 13
15 7 12
14 6, 7 11
12-13 6, 7 10
9-12 6 9

Ionic tour UI

Angular RxJS Ionic ngx-ui-tour
18 7 8 5
18 7 7, 8 4
17 7 7, 8 3
16 7 6, 7 2
15 7 6, 7 1

Taiga UI tour UI

Angular RxJS Taiga UI ngx-ui-tour
18 7 3 7
17 7 3 6
16 7 3 5
15 7 3 4
14 6, 7 3 3
12-13 6, 7 2 2
9-12 6 2 1

Installation and Usage

FAQ

Documentation page

Step Configuration

Documentation page

Defaults

Documentation page

TourService

Documentation page

Event Observables

Documentation page

Hotkeys

Documentation page

Custom template

Documentation page

Styling Active Tour Anchor

Documentation page

Targeting third party elements

Documentation page

License

MIT