Introduction
Attention
This documentation is still in progress. Some components may not be fully documented yet.
Twistail is a thoughtfully crafted component library designed for modern React applications. Built on the foundation of Radix UI Primitives, Tailwind CSS v4, Tailwind Variants, and TypeScript, it offers a comprehensive suite of accessible, customizable, and type-safe components to streamline your development process.
Core Principles
- Tailwind Variants - Leveraging the power of Tailwind Variants for advanced styling control
- Accessibility First - Every component adheres to WCAG guidelines and WAI-ARIA patterns
- Developer Experience - Intuitive APIs with comprehensive TypeScript definitions
- Design Flexibility - Easily adapt components to match your unique design system
- Separation of Concerns - CSS files are separated from component logic for improved maintainability and readability
Why Twistail?
Twistail stands out from other component libraries like shadcn/ui by fully embracing Tailwind Variants - a powerful utility that combines Tailwind's flexibility with a first-class variant API. This key difference provides:
- Superior Variant Management - Create complex component states with a clean, declarative API
- Responsive Variants - Easily define different styles across breakpoints
- Slot-based Styling - Apply styles to specific parts of components with precision
- Conflict Resolution - Automatic handling of conflicting Tailwind classes
- Type Safety - Full TypeScript integration for autocomplete and error prevention
Installation
Quick setup guide to integrate Twistail into your project.
Theming
Learn how to customize and extend component styles with Tailwind Variants.
Components
Browse our component library with usage examples.
Contributing
Learn how to contribute to the Twistail project.
Design Philosophy
Twistail follows a component architecture that maximizes the benefits of Tailwind Variants while separating styling from logic. This approach offers:
- Improved Readability - Cleaner component files with variant definitions clearly separated
- Enhanced Maintainability - Style variants can be modified without affecting component logic
- Better Collaboration - Designers can work on style variants while developers focus on functionality
- Simplified Theming - Create theme variants with minimal code duplication
- Consistent API - Uniform pattern for handling component variations across the library
This architecture creates a more sustainable and flexible codebase that scales with your project's complexity.
FAQs
Acknowledgements
Twistail is a thoughtful blend of design philosophies from two exceptional UI libraries:
-
Tremor: Many of Twistail's foundational components draw heavy inspiration from Tremor's well-crafted designs. We've reimagined these components with our own architectural approach while respecting Tremor's excellent work.
-
shadcn/ui: Twistail incorporates design patterns and component structures from shadcn/ui, adapting them to fit seamlessly with the Twistail ecosystem.
Key differences that set Twistail apart include:
- Separation of style files for each component, improving organization and customization
- Use of Lucide icons instead of Remix Icons (used by Tremor)
- Integration of Tailwind Variants for enhanced styling capabilities
- A carefully curated blend of design elements from both inspirational libraries
We're grateful to these projects for their contributions to the React and Tailwind ecosystem, and for providing the foundation upon which Twistail builds its unique identity.
Join the Community
Twistail is more than just a component library - it's a growing community of developers building better user interfaces with modern tools like Tailwind Variants. Connect with us:
- Star our GitHub repository
- Follow us for updates and announcements
- Share your projects built with Twistail
We're excited to see what you create!
Last updated on