TrizTech/ohif-viewer
15
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add demo

Browse Source
This commit is contained in:
Ibrahim 2024-10-04 12:42:19 -04:00
parent 69a620ac68
commit ea961d6b66
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
platform/docs/docs/configuration/tour-demo.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.5 MiB

6
platform/docs/docs/configuration/tours.md
View File

@ -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.
@ -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.