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
Anatomy
Understanding the structure of the Walkthrough component helps ensure proper implementation and customization.
| Property | Description | Type |
|---|---|---|
| root | Slot rendered into [data-slot="walkthrough"]. | Root |
| content | Content region of the component. | Part |
| title | Slot rendered into [data-slot="walkthrough-title"]. | Slot |
| description | Slot rendered into [data-slot="walkthrough-description"]. | Slot |
| controls | Slot rendered into [data-slot="walkthrough-controls"]. | Slot |
| skip | Slot rendered into [data-slot="walkthrough-skip"]. | Slot |
| prev | Slot rendered into [data-slot="walkthrough-prev"]. | Slot |
| next | Slot rendered into [data-slot="walkthrough-next"]. | Slot |
| dots | Dots region of the component. | Part |
| dot | Slot rendered into [data-slot="walkthrough-dot"]. | Slot |
| dotActive | Dot active region of the component. | Part |
| counter | Slot rendered into [data-slot="walkthrough-counter"]. | Slot |
Variants & States
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
Advanced Usage
Complex patterns including composition, state management, and real-world scenarios.
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?