Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tnicola/ngx-joyride
Angular Joyride/Tour library
https://github.com/tnicola/ngx-joyride
angular angular2 demo directive joyride onboarding tour ui-component
Last synced: about 2 months ago
JSON representation
Angular Joyride/Tour library
- Host: GitHub
- URL: https://github.com/tnicola/ngx-joyride
- Owner: tnicola
- License: mit
- Created: 2018-04-22T11:10:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T05:04:28.000Z (over 1 year ago)
- Last Synced: 2024-07-18T15:47:14.487Z (2 months ago)
- Topics: angular, angular2, demo, directive, joyride, onboarding, tour, ui-component
- Language: TypeScript
- Homepage: https://tnicola.github.io/ngx-joyride/
- Size: 5.69 MB
- Stars: 244
- Watchers: 7
- Forks: 98
- Open Issues: 83
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/ngx-joyride)
[](https://circleci.com/gh/tnicola/ngx-joyride/tree/master)
[](https://codecov.io/gh/tnicola/ngx-joyride)
[](https://dashboard.cypress.io/#/projects/3yary2/runs)
# Angular Joyride
An Angular Tour (Joyride) library built entirely in Angular, without using any heavy external dependencies like Bootstrap or JQuery.
From now on you can easily guide your users through your site showing them all the sections and features.
For Angular 2+ (2 - 13)
## Demo
See the [demo](https://tnicola.github.io/ngx-joyride/). Let's take a tour! ✈️ :earth_americas:
## Install
npm install ngx-joyride --save
or
yarn add ngx-joyride
## Usage
#### 1. Mark your HTML elements with the `joyrideStep` directive
```typescript
Text
Div content
```
#### 2. Import the `JoyrideModule` in your AppModule
```typescript
@NgModule({
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
```typescript
@Component({
selector: 'app-component',
templateUrl: './app.component.html',
})
export class AppComponent {
constructor(private readonly joyrideService: JoyrideService) {}
onClick() {
this.joyrideService.startTour(
{ steps: ['firstStep', 'secondStep'] } // Your steps order
);
}
}
```
#### 4. En-joy :wink:
# API reference
## Directive Inputs/Outputs
You can use the `joyrideStep` directive with these inputs:
| @Input | Required | Purpose | Values/Type |
| ----------------- | -------- | ---------------------------------------------------- | ------------------------------------------ |
| joyrideStep | Yes | The step name, it should be unique. | string |
| stepPosition | No | The position in which the step will be drawn. | 'top', 'right', 'bottom', 'left', 'center' |
| title | No | The step title. | string |
| text | No | The step text content. | string |
| stepContent | No | An Angular template with custom content. | TemplateRef\ |
| stepContentParams | No | Data object to pass in with Angular template | Object |
| prevTemplate | No | An Angular template with a custom prev button. | TemplateRef\ |
| nextTemplate | No | An Angular template with a custom next button. | TemplateRef\ |
| doneTemplate | No | An Angular template with a custom done button. | TemplateRef\ |
| counterTemplate | No | An Angular template with a custom counter component. | TemplateRef\ |
| @Output | Required | Purpose |
| ------- | -------- | ------------------------------------------------------------------------------------- |
| next | No | It fires an event when 'Next' button is clicked. |
| prev | No | It fires an event when 'Prev' button is clicked. |
| done | No | It fires an event when 'Done' button or 'Close' are clicked and the Tour is finished. |
## Options
| Name | Required | Purpose | Type | Default value |
| ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------- |
| steps | Yes | Represent the ordered list of steps name to show. e.g `steps: ['step1', 'header', 'interesting-table', 'navbar']`. This option is particularly useful for multi-pages navigation. If your step is not in the root path, you should indicate the route after the step name, with a `@` as separator. E.g. : `steps: ['firstStep', 'image@home', 'step4@about/you', 'user-avatar@user/details']` | string[] | none |
| startWith | No | The name of the step (plus the route for multi-page navigation) from which the stour should start. | string | undefined |
| waitingTime | No | The time (in milliseconds) to wait before showing the next/prev step. | number | 1 |
| stepDefaultPosition | No | Define a step default position. The stepPositon set in the directive override this value. | string | bottom |
| themeColor | No | Backdrop, buttons and title color. (Hexadecimal value) | string | #3b5560 |
| showCounter | No | Show the counter on the bottom-left. | boolean | true |
| showPrevButton | No | Show the "Prev" button. | boolean | true |
| logsEnabled | No | Enable logs to see info about the library status. Usuful to get a meaningful error message. | boolean | false |
| customTexts | No | Custom buttons text for next, prev, done buttons. | Object | `{ prev: 'prev', next: 'next', done: 'done'}` |
You can change each element step css overriding the default style.
# How tos
- [Use Custom Content](#use-custom-content)
- [Use Custom Content With Dynamic Data](#use-custom-content-with-dynamic-data)
- [Use custom buttons and/or counter](#use-custom-buttons-and/or-counter)
- [Set the options](#set-the-options)
- [Listen for events](#listen-for-events)
- [Multi Pages navigation](#get-multi-pages-navigation)
- [Close programmatically the tour](#close-programmatically-the-tour)
### Use Custom Content
If you'd like to use custom HTML content instead of simple text you can use the `stepContent` property instead of `text`. Let's see how.
```html
I'm the target element.
... Insert whatever you'd like to ...
```
### Use Custom Content With Dynamic Data
If you'd like to pass params to template, use the `stepContentParams` property. Let's see how.
```html
I'm the target element.
Hello {{person}}
```
### Use custom buttons and/or counter
#### Custom buttons texts
If you'd like to customize the next, prev and done texts, you can use the `customTexts` option:
```typescript
this.joyrideService.startTour({
...
customTexts: {
next: '>>',
prev: '<<',
done: 'Ok'
}
});
```
#### Custom buttons templates
If you'd like to customize the next, prev and done button or you want to use your own counter component, you can:
**Important**: These inputs should be used just once, in the first step of your tour.
```html
I'm the target element.
Go back!
Go ahead!
Complete
{{ step }} of {{ total }} steps
```
N.B.: The counter template has 2 parameters, `step` represents the current step number, `total` is the total number of steps.
### Set the options
```typescript
this.joyrideService.startTour({
steps: ['step1', 'my-step@home', 'lastStep@home'],
showPrevButton: false,
stepDefaultPosition: 'top',
themeColor: '#212f23',
});
```
### Listen for events
**Mode 1: Using directive output events**
```typescript
@Component({
selector: 'app-component',
template: `
Hello!
Hello!
`,
})
export class AppComponent {
constructor(private readonly joyrideService: JoyrideService) {}
onClick() {
this.joyrideService.startTour(
{ steps: ['joy1', 'joy2'] } // Your steps order
);
}
onNext() {
// Do something
}
onPrev() {
// Do something
}
onDone() {
// Do something
}
}
```
**Mode 2: Subscribing to startTour**
```typescript
@Component({
selector: 'app-component',
template: `
Hello!
Hello!
`,
})
export class AppComponent {
constructor(private readonly joyrideService: JoyrideService) {}
onClick() {
this.joyrideService.startTour({ steps: ['joy1', 'joy2'] }).subscribe(
(step) => {
/*Do something*/
},
(error) => {
/*handle error*/
},
() => {
/*Tour is finished here, do something*/
}
);
}
}
```
N.B.: Using events is very helpful when your next target is hidden in the DOM. If a target is not visible (e.g. \*ngIf='false') you should use the (next) event to make the target somehow findable in the DOM.
### Get Multi Pages navigation
If your steps are scattered among different pages you can now reach them, just add their name in the `steps` list followed by `@route/to/page`.
Lets suppose you have three steps:
- navbar, located in the app root /
- user-avatar, located in /user/details
- info, located in /about
What you should do is adding your steps in this way:
```typescript
...
this.joyrideService.startTour({steps: ["navbar", "user-avatar@user/details", "info@about"]});
...
```
**NB**: If you're using lazy modules, you should import the JoyrideModule in your AppModule using `JoyrideModule.forRoot()`. In your lazy loaded feature modules use `JoyrideModule.forChild()` instead.
### Close programmatically the tour
In order to close programmatically the tour you'll just need to call the JoyrideService `closeTour()` method:
```typescript
...
this.joyrideService.closeTour();
...
```
## Licence
MIT