Skip to content

Commit

Permalink
Shepherd v6
Browse files Browse the repository at this point in the history
  • Loading branch information
RobbieTheWagner committed Nov 8, 2019
1 parent 4526871 commit 7c06e41
Show file tree
Hide file tree
Showing 9 changed files with 563 additions and 554 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ npm install angular-shepherd --save
**NOTE: This may not be the proper Angular way to do everything, as I am not
an Angular dev, so please let me know if you have suggestions!**

Shepherd ships a single style file, which you will need to include. You can do so by adding it
to your angular.json.

```json
"styles": [
"node_modules/shepherd.js/dist/css/shepherd.css"
],
```

Then, you will need to inject the `ShepherdService` to be able to interact with Shepherd and
call `addSteps` to add your steps, `start` to start the tour, etc.

Expand All @@ -55,7 +64,6 @@ export class ShepherdComponent implements AfterViewInit {

ngAfterViewInit() {
this.shepherdService.defaultStepOptions = defaultStepOptions;
this.shepherdService.disableScroll = true;
this.shepherdService.modal = true;
this.shepherdService.confirmCancel = false;
this.shepherdService.addSteps(defaultSteps);
Expand Down Expand Up @@ -128,14 +136,6 @@ this.shepherdService.requiredElements = [

> **default value:** `[]`

### disableScroll

`disableScroll` is a boolean, that when set to true, will keep the user from scrolling with the scrollbar,
mousewheel, arrow keys, etc. You may want to use this to ensure you are driving the scroll position with the tour.

> **default value:** `false`
### modal

`modal` is a boolean, that should be set to true, if you would like the rest of the screen, other than the current element,
Expand Down
1 change: 1 addition & 0 deletions angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"projects/shepherd-tester/src/assets"
],
"styles": [
"node_modules/shepherd.js/dist/css/shepherd.css",
"projects/shepherd-tester/src/styles.css"
],
"scripts": [],
Expand Down
Loading

0 comments on commit 7c06e41

Please sign in to comment.