Skip to main content
Version: 3.10.0-beta.120 (Latest)

Tours and Onboarding

Migration Guide: Tours​

  • Tours are no longer defined directly in window.config.tours but through the customization service under the key ohif.tours
  • The waitForElement utility function has been moved from the config file to a dedicated customization file
  • The structure of tour definitions (steps, options, etc.) remains largely the same

Migration Steps:​

1. Update any direct references to window.config.tours​

If you have any code that directly references window.config.tours, update it to use the customization service:

- const tours = window.config.tours;
+ const tours = customizationService.getCustomization('ohif.tours');

2. Use config update patterns for configuring tours​

Before:

- window.config = {
-   tours: [
-     {
-       id: 'basicViewerTour',
-       route: '/viewer',
-       steps: [
-         // tour steps...
-       ],
-       tourOptions: {
-         // tour options...
-       },
-     },
-   ],
- };

After:

window.config = {
  customizationService: {
    'ohif.tours': {
      $set: [
        {
          id: 'basicViewerTour',
          route: '/viewer',
          steps: [
            // Your tour steps
          ],
        },
      ],
    },
  },
};

Benefits of the Change​

  1. Mode-specific Tours: now you can have different tours for different modes