TouchSpin Documentation Hub
September 23, 2025 · View on GitHub
Your entry point for architecture, extension, and reference material across the TouchSpin monorepo. Start here to explore how the TypeScript codebase is structured, how to extend it, and where to find legacy notes.
🧭 Start Here
| Topic | Read This | Why |
|---|---|---|
| Modern architecture overview | Architecture Overview | Understand package roles, runtime flow, and extensibility points |
| Evolution history | Architecture History | See how the project moved from jQuery to modular TypeScript |
| Migrating legacy code | Migration Guide | Align older integrations with the current API |
| Adding a renderer | Renderer Guide & Creating a Custom Renderer | Build support for another design system |
| Framework wrappers | Framework Wrapper Guide | Wrap the core for React, Vue, Angular, or Web Components |
🔍 Quick Navigation
- Architecture Analysis: Method comparison, migration guide, three-stage evolution
- Reference: API quick reference, options ↔ feature matrix, event matrix, renderer checklist, options & events overview
- Visuals: Core diagrams live in architecture/diagrams/ (overview, data flow, initialization, event timeline, boundary handling, more)
- Legacy Archive: Historical pseudo-code, JSON models, and test traceability live under legacy/ for research only
📚 Suggested Workflows
- New contributor → read the Architecture Overview, then skim Architecture History for context.
- Porting a legacy project → follow the Migration Guide and consult the event matrix for differences.
- Implementing a renderer → start with the Renderer Guide, then dive into Creating a Custom Renderer and the renderer checklist.
- Publishing framework bindings → review the Framework Wrapper Guide and reuse the patterns shown there.
- Debugging behavior → inspect the event lifecycle diagram alongside the options matrix and options & events overview.