Skip to content

Commit 7c06e41

Browse files
Shepherd v6
1 parent 4526871 commit 7c06e41

File tree

9 files changed

+563
-554
lines changed

9 files changed

+563
-554
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,15 @@ npm install angular-shepherd --save
3131
**NOTE: This may not be the proper Angular way to do everything, as I am not
3232
an Angular dev, so please let me know if you have suggestions!**
3333

34+
Shepherd ships a single style file, which you will need to include. You can do so by adding it
35+
to your angular.json.
36+
37+
```json
38+
"styles": [
39+
"node_modules/shepherd.js/dist/css/shepherd.css"
40+
],
41+
```
42+
3443
Then, you will need to inject the `ShepherdService` to be able to interact with Shepherd and
3544
call `addSteps` to add your steps, `start` to start the tour, etc.
3645

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

5665
ngAfterViewInit() {
5766
this.shepherdService.defaultStepOptions = defaultStepOptions;
58-
this.shepherdService.disableScroll = true;
5967
this.shepherdService.modal = true;
6068
this.shepherdService.confirmCancel = false;
6169
this.shepherdService.addSteps(defaultSteps);
@@ -128,14 +136,6 @@ this.shepherdService.requiredElements = [
128136

129137
> **default value:** `[]`
130138
131-
132-
### disableScroll
133-
134-
`disableScroll` is a boolean, that when set to true, will keep the user from scrolling with the scrollbar,
135-
mousewheel, arrow keys, etc. You may want to use this to ensure you are driving the scroll position with the tour.
136-
137-
> **default value:** `false`
138-
139139
### modal
140140

141141
`modal` is a boolean, that should be set to true, if you would like the rest of the screen, other than the current element,

angular.json

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
"projects/shepherd-tester/src/assets"
5959
],
6060
"styles": [
61+
"node_modules/shepherd.js/dist/css/shepherd.css",
6162
"projects/shepherd-tester/src/styles.css"
6263
],
6364
"scripts": [],

0 commit comments

Comments
 (0)