Walkthrough

Step-by-step guided tour overlay anchored to page elements. Manages step progression and keyboard navigation.

Overview

Purpose

The Walkthrough component step-by-step guided tour overlay anchored to page elements. manages step progression and keyboard navigation.within our design system. It follows our composer layer principles, ensuring consistency and reusability across applications.

When to Use

  • Use when you need providing system feedback
  • Appropriate for feedback contexts
  • Follows composer component patterns

When Not to Use

  • Avoid when simpler alternatives exist
  • Don't use for permanent content
  • Consider alternatives for edge cases

Live Example

import React from 'react';
import Walkthrough from './components/Walkthrough';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Walkthrough {...props}>
        {props.children || 'Example walkthrough content'}
      </Walkthrough>
    </div>
  );
}

Anatomy

Understanding the structure of the Walkthrough component helps ensure proper implementation and customization.

Property Description Type
rootSlot rendered into [data-slot="walkthrough"].Root
contentContent region of the component.Part
titleSlot rendered into [data-slot="walkthrough-title"].Slot
descriptionSlot rendered into [data-slot="walkthrough-description"].Slot
controlsSlot rendered into [data-slot="walkthrough-controls"].Slot
skipSlot rendered into [data-slot="walkthrough-skip"].Slot
prevSlot rendered into [data-slot="walkthrough-prev"].Slot
nextSlot rendered into [data-slot="walkthrough-next"].Slot
dotsDots region of the component.Part
dotSlot rendered into [data-slot="walkthrough-dot"].Slot
dotActiveDot active region of the component.Part
counterSlot rendered into [data-slot="walkthrough-counter"].Slot

Variants & States

import React from 'react';
import Walkthrough from './components/Walkthrough';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Walkthrough {...props}>
        {props.children || 'Example walkthrough content'}
      </Walkthrough>
    </div>
  );
}

API Reference

Props

No props extracted. Props may be inherited or use complex types.

Accessibility

Standards Compliance

This component follows WCAG 2.1 AA guidelines and includes proper ARIA attributes, keyboard navigation, and screen reader support.

Accessibility Checklist

  • ○ Keyboard navigation support
  • ○ Screen reader compatibility
  • ○ Color contrast compliance
  • ○ Focus management
  • ○ ARIA attributes
  • ○ Reduced motion support

Usage Guidelines

Do

  • Use consistent spacing and sizing
  • Follow established patterns
  • Provide clear labels and descriptions
  • Test with assistive technologies

Don't

  • Override core functionality
  • Use without proper context
  • Ignore accessibility requirements
  • Modify without design system approval

Examples

Basic Usage

Simple implementation with default props and common configurations.

import React from 'react';
import Walkthrough from './components/Walkthrough';
import props from '/props.json';

export default function App() {
  return (
    <div style={{ padding: '2rem', display: 'flex', alignItems: 'center', justifyContent: 'center', minHeight: '100vh' }}>
      <Walkthrough {...props}>
        {props.children || 'Example walkthrough content'}
      </Walkthrough>
    </div>
  );
}

Advanced Usage

Complex patterns including composition, state management, and real-world scenarios.

import React from 'react';

export default function App() {
  return (
    <div style={{ 
      padding: '2rem', 
      display: 'flex',
      flexDirection: 'column',
      gap: '1.5rem'
    }}>
      <h3>Walkthrough - Advanced Patterns</h3>
      <p>Advanced usage patterns for Walkthrough include:</p>
      <ul>
        <li>Composition with other components</li>
        <li>Custom styling and theming</li>
        <li>Controlled vs uncontrolled patterns</li>
        <li>Form integration</li>
        <li>Accessibility enhancements</li>
      </ul>
      <p style={{ color: '#6b7280', fontStyle: 'italic' }}>
        Full advanced examples coming soon.
      </p>
    </div>
  );
}

Development Tools

Use these tools to analyze the component's performance, design tokens, and accessibility during development.

Contribute

Help us improve the Walkthrough component documentation. Found an issue or have suggestions?

Related Components