# angular-custom-tour

> Easy to customize Angular 2+ tour

Latest version **0.0.18** (published 2019-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install angular-custom-tour
pnpm add angular-custom-tour
yarn add angular-custom-tour
bun add angular-custom-tour
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.18 |
| Published | 2019-04-16 |
| First published | 2017-05-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 127.3 KB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 24 |
| Maintainers | miraxes |
| Keywords | angular, angular2, ng2, ngx, hint, step, tour |

## Links

- npm: https://www.npmjs.com/package/angular-custom-tour
- Repository: https://github.com/miraxes/angular-custom-tour
- Homepage: https://github.com/miraxes/angular-custom-tour#readme
- Issues: https://github.com/miraxes/angular-custom-tour/issues
- npm.io page: https://npm.io/package/angular-custom-tour

## Dependencies (1)

- [@angular/platform-server](https://npm.io/package/@angular/platform-server.md) 4.4.6

## Recent versions

- 0.0.18 (latest) — 2019-04-16
- 0.0.17 — 2017-12-20
- 0.0.16 — 2017-06-06
- 0.0.15 — 2017-06-06
- 0.0.14 — 2017-06-03
- 0.0.13 — 2017-06-03
- 0.0.12 — 2017-06-03
- 0.0.11 — 2017-06-03
- 0.0.10 — 2017-06-03
- 0.0.9 — 2017-06-03
- 0.0.8 — 2017-06-02
- 0.0.7 — 2017-06-01
- 0.0.6 — 2017-06-01
- 0.0.5 — 2017-06-01
- 0.0.4 — 2017-05-31
- … 2 more at https://npm.io/package/angular-custom-tour/versions

## README

[![Build Status](https://img.shields.io/travis/miraxes/angular-custom-tour.svg?style=flat-square)](https://travis-ci.org/miraxes/angular-custom-tour)
[![Downloads](https://img.shields.io/npm/dt/angular-custom-tour.svg?style=flat-square)](https://www.npmjs.com/package/angular-custom-tour)
[![Versions](https://img.shields.io/npm/v/angular-custom-tour.svg?style=flat-square)]()
[![License](https://img.shields.io/npm/l/angular-custom-tour.svg?style=flat-square)]()

# How it works?

![demo GIF](/demo.gif)

# Demo
[https://miraxes.github.io/angular-custom-tour](https://miraxes.github.io/angular-custom-tour)


# Custom tour with Angular 2+

Follow instructions and everything should be fine. :)

# Usage

  * install `npm install angular-custom-tour --save`

In your module (app.module.ts)
  ```typescript
  import { HintModule } from 'angular-custom-tour'

  @NgModule({
    ...
    imports: [
      ...
      HintModule // Put here
      ...
    ]
    ...
  ]
  ```
Initialize it in your page component

> In case you want to init slider after pageload, you should use ngAfterViewInit
  ```typescript
  import { HintService } from 'angular-custom-tour'

  @Component({
    ...
    providers: [... HintService ... ],
    ...
  })

  class AppComponent {

    constructor(public hintService: HintService){ }

    startTour() {
      this.hintService.initialize();
    }

  }
  ```

  ```html
  <!-- Bluring element insert on top of the page-->
  <tour-overlay></tour-overlay>

  <!-- start TOUR -->
  <button name="button" (click)="startTour()"> START!</button>

  <!-- Each step could be placed at ANYWHERE -->
  <div class="i-want-highlight-this" id="highlight-me"> WOW!</div>

  <tour-step selector="highlight-me" order="3" position="right" title="title string">
    <!-- ANY HTML HERE
      NOTE: ONLY selector attribute is required! others is up to you
    -->
  </tour-step>
  ```
  ## NOTE:

  > selector MUST BE unique, so you can highlight Element once

## Styles

You need to inject styles from `styles/main.css`

if you are using  angular CLI -> angular-cli.json
```
"styles": [
        ...
        "styles.scss",
        "../node_modules/angular-custom-tour/styles/main.css"
        ...
      ],
```


# Custom options Usage

```typescript
  startTour() {
    this.hintService.initialize({elementsDisabled: false}); // HintOptions
  }
```

## HintOptions

| option                     | default   | Usage  |
| -------------------------- |:---------:| ------ |
| elementsDisabled: boolean  | true      | Disabling highlightedElement (click) wont work|
| dismissOnOverlay: boolean  | false     | Go to next step when clicking on overlay (close tour if this is last step)|
| defaultPosition: string    | 'bottom'  | Position of tour step to highlightedElement |
| defaultOrder: number       | 99        | Order of showing steps |
| defaultLayer: number       | 15        | Distance between highlightedElement and step in px |
| applyRelative: boolean     | true      | Applying position:relative to highlightedElement (disable in case you want to highlight absolute positioned elements) |


##  Hint service events

| event         | Description  |
| ------------- | ------------ |
| finish$       | When tour is finished |
| showingStep$  | On each step show (Params > CurrentStep) |


This module in active development mode, if you have any suggestions feel free to contact me.

---
_Source: https://npm.io/package/angular-custom-tour · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._