Skip to content

Commit

Permalink
add demo
Browse files Browse the repository at this point in the history
  • Loading branch information
IbrahimCSAE committed Oct 4, 2024
1 parent 69a620a commit ea961d6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
Binary file added platform/docs/docs/configuration/tour-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion platform/docs/docs/configuration/tours.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 3
sidebar_label: Tours
---

# Configuring Tours with Shepherd.js
# Configuring Tours in OHIF with Shepherd.js

In OHIF, you can configure guided tours for users by leveraging [Shepherd.js](https://shepherdjs.dev/), a JavaScript library for building feature tours. This page explains how you can define and customize these tours within your app configuration file.

Expand Down Expand Up @@ -142,6 +142,10 @@ when: {

Once you have a basic tour in place, you can extend it with more advanced features like custom scrolling behavior, dynamic elements, and event-based step advancement. For more details, check out the [Shepherd.js documentation](https://shepherdjs.dev/).

## Demo

![Tour Demo](<tour-demo.gif>)

## Conclusion

By leveraging **Shepherd.js**, you can provide users with interactive and informative guided tours of the viewer. This can greatly improve the user experience and help users understand how to use key features.

0 comments on commit ea961d6

Please sign in to comment.