Tour

Step-by-step guided walkthrough that highlights UI elements with a spotlight overlay and tooltip navigation.

This component requires softui.js for interactive behavior.

Default

AB
Alex Brown
Product Designer

Project Overview

Your dashboard shows all active projects and team activity.


<!-- Target elements with IDs -->
<div id="my-avatar">...</div>
<div id="my-card">...</div>
<button id="my-button">...</button>

<!-- Start the tour -->
<script>
  SoftUI.tour([
    {
      target: '#my-avatar',
      title: 'Your Profile',
      description: 'Click to view your account settings.',
      position: 'right'
    },
    {
      target: '#my-card',
      title: 'Dashboard',
      description: 'See your active projects here.',
      position: 'bottom'
    },
    {
      target: '#my-button',
      title: 'Create Project',
      description: 'Start a new project from here.',
      position: 'bottom'
    }
  ]);
</script>

<!-- Position options: 'top', 'bottom', 'left', 'right' -->

Without Overlay

3 new Online

Notifications

You have 3 unread notifications.

<script>
  SoftUI.tour([
    { target: '#badge', title: 'Notifications', description: 'You have new notifications.', position: 'bottom' },
    { target: '#card', title: 'Panel', description: 'Expand to see all.', position: 'bottom' }
  ], { noOverlay: true });
</script>

API

SoftUI.tour(steps, options)

Steps (array of objects):
  • target — CSS selector for the element to highlight
  • title — Step title text
  • description — Step description text
  • position — Tooltip position: 'top', 'bottom', 'left', 'right'
Options:
  • padding — Spotlight padding around target (default: 8)
  • noOverlay — Skip backdrop overlay (default: false)
  • onComplete — Callback when tour finishes
Returns:
  • next() — Go to next step
  • prev() — Go to previous step
  • goTo(index) — Jump to specific step
  • close() — End the tour
<script>
  // Start a tour and get control handle
  var myTour = SoftUI.tour([
    { target: '#step1', title: 'First', description: 'Welcome!', position: 'bottom' },
    { target: '#step2', title: 'Second', description: 'Next feature.', position: 'right' },
    { target: '#step3', title: 'Done', description: 'All set!', position: 'top' }
  ], {
    padding: 12,
    noOverlay: false,
    onComplete: function() {
      console.log('Tour finished!');
    }
  });

  // Programmatic control
  myTour.next();
  myTour.prev();
  myTour.goTo(2);
  myTour.close();
</script>

Delete this item?

This action cannot be undone. This will permanently delete the item and remove all associated data.