Docs
Components
Tour

The Tour Component

<Tour> is a guided, anchored step sequence for onboarding flows.

Usage

v2-feature-tour.tsx
import { Tour } from 'featuredrop/react'
 
const steps = [
  {
    id: 'sidebar',
    target: '#sidebar-nav',
    title: 'Redesigned sidebar',
    content: 'Primary navigation is now grouped by workflow.'
  },
  {
    id: 'quick-actions',
    target: '#quick-actions-bar',
    title: 'Quick actions',
    content: 'Create reports and exports from one place.'
  }
]
 
<Tour id="v2-dashboard-tour" steps={steps} onTourCompleted={() => console.log('Tour done')} />

Key props

PropTypeNotes
idstringRequired stable tour id
stepsTourStep[]Required ordered steps
overlaybooleanBackdrop on/off
showProgressbooleanProgress indicator
persistencebooleanResume from saved step
onTourCompleted / onTourSkippedcallbacksLifecycle events
⚠️

Keep targets stable and include a skip path (Esc is supported). Missing targets are skipped.

Interactive Demo