ngx-ui-tour-ng-zorro
v2.0.0
Published
UI tour library for Angular
Downloads
67
Maintainers
Readme

UI tour library for Angular
Angular Material, Ionic, PrimeNG, Taiga UI, NG ZORRO and Ng 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.
Table of contents
- Demo and documentation
- Compatibility
- Installation and Usage
- FAQ
- TourService
- Step Configuration
- Defaults
- Hotkeys
- Event Observables
- Custom template
- Styling Active Tour Anchor
- Targeting Third Party Elements
- License
Demo and documentation
Demo and documentation can be found at hakimio.github.io/ngx-ui-tour
Compatibility
Material Design tour UI
| Angular | RxJS | ngx-ui-tour | |---------|------|-------------| | 22 | 7 | 17 | | 21 | 7 | 16 | | 20 | 7 | 15 | | 19 | 7 | 14 | | 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 | |---------|------|-------------| | 22 | 7 | 19 | | 21 | 7 | 18 | | 20 | 7 | 17 | | 19 | 7 | 16 | | 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 | |---------|------|-------|-------------| | 22 | 7 | 8 | 9 | | 21 | 7 | 8 | 8 | | 20 | 7 | 8 | 7 | | 19 | 7 | 8 | 6 | | 18 | 7 | 8 | 5 | | 18 | 7 | 7, 8 | 4 | | 17 | 7 | 7, 8 | 3 | | 16 | 7 | 6, 7 | 2 | | 15 | 7 | 6, 7 | 1 |
PrimeNG tour UI
| Angular | RxJS | PrimeNG | ngx-ui-tour | |---------|------|---------|-------------| | 22 | 7 | 22 | 4 | | 21 | 7 | 21 | 3 | | 20 | 7 | 20 | 2 | | 19 | 7 | 19 | 1 |
NG ZORRO tour UI
| Angular | NG ZORRO | ngx-ui-tour | |---------|----------|-------------| | 22 | 22 | 2 | | 21 | 21 | 1 |
Taiga UI tour UI
| Angular | RxJS | Taiga UI | ngx-ui-tour | |---------|------|----------|-------------| | 22 | 7 | 5 | 11 | | 21 | 7 | 5 | 10 | | 20 | 7 | 4 | 9 | | 19 | 7 | 4 | 8 | | 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
- Material Design UI
- Ionic UI
- PrimeNG UI
- NG ZORRO UI
- NG Bootstrap UI
- Taiga UI Dropdown UI
- Taiga UI Hint UI
- JavaScript Console UI
FAQ
Step Configuration
Defaults
TourService
Event Observables
Hotkeys
Custom template
Styling Active Tour Anchor
Targeting third party elements
License
MIT
