Skip to content

Add multiple events example to docs #1086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobbieTheWagner merged 1 commit into from
Aug 5, 2020
Merged

Add multiple events example to docs #1086

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs-src/tutorials/02-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ event handlers a `tour` key pointing to the instance which fired the event:
- `active`
- `inactive`

For multiple events, you can use something like:

```javascript
['close', 'cancel'].forEach(event => shepherd.on(event, () => {
// some code here
}));
```

##### Current Tour

The global `Shepherd` includes a property which is always set to the currently active tour, or null if there is no active tour:
Expand Down