How uixmat/onborda works
Main Components
a) Core Components Layer:
• Onborda Component
• OnbordaProvider (Context)
• Custom Card Component Interface
b) Integration Layer:
• Next.js Application Integration
• Framer Motion Integration
• TailwindCSS Integration
c) Feature Layer:
• Tour Management System
• Step Navigation System
• Pointer/Tooltip System
┌─ Application Layer ─────────────────────┐
• Next.js Application │
• (Consumer of Onborda) │
• ┬─────────────────────────┘
• ↓
┌─ Core Layer ──────────────────────────────────────────┐
• ┌─ OnbordaProvider ─┐ ┌─ Onborda Component ─┐ │
• Context State │ ←→ │ Step Management │ │
• Tour Management │ │ Navigation Logic │ │
• ┘ └──────────────────────┘ │
• ┬──────────────────────┬────────────────┘
• ↓ ↓
┌─ Feature Layer ───────┐ ┌─ UI Layer ────────────┐
• • Tour System │ │ • Default Card │
• • Step Navigation │ │ • Custom Card │
• • Route Management │ │ • Pointer System │
• ┬──────────────┘ └──────────┬────────────┘
• ↓ ↓
┌─ Integration Layer ───────────────────────────────────┐
• Framer Motion TailwindCSS │
• (Animations) (Styling) │
• ┘
Important Flows to Highlight
• Data flow from OnbordaProvider to Onborda component
• Step navigation flow between components
• Integration points with Next.js routing system
• Custom card component injection flow
Additional Details
• Step object structure
• Tour management system
• Pointer positioning system
• Card component props flow
Technical Specifications to Note
• TypeScript interfaces
• Component prop types
• Available configuration options
• Animation transition types
Implementation Notes
• The lightweight nature of the library
• The flexibility of the custom card system
• The integration with Next.js routing
• The separation between core functionality and UI components
Remember to:
• Version information
• Dependencies (framer-motion, tailwindcss)