Skip to content

Trilitech’s design system for Tezos marketing experiences, built for consistency, accessibility, and scalability.

Notifications You must be signed in to change notification settings

trilitech/tezosx-ui

Repository files navigation

tezosx-ui

Trilitech's design system for Tezos marketing experiences, built for consistency, accessibility, and scalability.

License: MIT Version


🚀 Overview

tezosx-ui is a production-ready component registry built on shadcn/ui that provides a comprehensive design system for Tezos marketing websites and applications.

✅ Now Available

  • 6 production-ready components with Tezos-branded styling
  • Dynamic color system for multi-brand flexibility
  • Dark mode support out of the box
  • TypeScript-first with full type safety
  • Tailwind CSS for complete customization
  • One-command installation via shadcn CLI
  • Fully tested and ready for production use

📦 Installation

Install components directly into your project using the shadcn CLI:

# Install a single component
npx shadcn@latest add https://tezosx-ui.vercel.app/registry/tezosx/button.json

# Install multiple components at once
npx shadcn@latest add \
  https://tezosx-ui.vercel.app/registry/tezosx/button.json \
  https://tezosx-ui.vercel.app/registry/tezosx/label.json \
  https://tezosx-ui.vercel.app/registry/tezosx/input.json \
  https://tezosx-ui.vercel.app/registry/tezosx/card.json \
  https://tezosx-ui.vercel.app/registry/tezosx/textarea.json \
  https://tezosx-ui.vercel.app/registry/tezosx/badge.json

All files install automatically - no manual setup required!


🎨 Components

Component Status Variants Description
Button Ready 5 variants, 4 sizes Primary, secondary, outline, ghost, destructive
Label Ready Default Accessible form labels
Input Ready All types Text, email, password, number, etc.
Card Ready 6 sub-components Flexible content container with header, footer
Textarea Ready Default Multi-line text input with resize
Badge Ready 6 variants Status indicators and tags
Checkbox 🚧 Coming Soon - Accessible checkbox (with Radix UI)
Select 🚧 Coming Soon - Dropdown selection (with Radix UI)
Dialog 🚧 Coming Soon - Modal dialogs (with Radix UI)
Accordion 🚧 Coming Soon - Collapsible content (with Radix UI)

6 components ready for production use! 🎉


🎨 Dynamic Theming

tezosx-ui uses CSS variables for easy color customization. Each marketing site can override colors without changing component code:

/* Your marketing site's custom colors */
:root {
  --primary: 220 90% 56%;
  --secondary: 280 70% 50%;
  /* ... override any color tokens */
}

Dark mode is automatically supported and can be toggled programmatically or via user preference.


📚 Documentation

Comprehensive documentation with interactive examples:

Each page includes live examples, code snippets, and API references.


🛠️ Tech Stack

  • Framework: Next.js 16 + TypeScript
  • Styling: Tailwind CSS v4
  • Components: Radix UI primitives
  • CLI: shadcn/ui
  • Documentation: Next.js MDX
  • Deployment: Vercel

🚀 Development Status

Current Version: v1.0.0
Status:Production Ready (6/10 components complete)

Progress

  • ✅ Planning & Architecture (100%)
  • ✅ Project Foundation (100%)
  • ✅ Theming System (100%)
  • ✅ Component Development (60% - 6/10 complete)
  • ✅ Registry Configuration (100%)
  • ✅ Documentation (100% for available components)
  • ✅ Deployment & Testing (100%)

✅ What's Ready

  • 6 production-ready components
  • Complete theming system with dark mode
  • Automatic component installation via CLI
  • Comprehensive documentation
  • Deployed and tested on Vercel

🚧 Coming Next (v1.1.0)

  • Checkbox component (with Radix UI)
  • Select component (with Radix UI)
  • Dialog component (with Radix UI)
  • Accordion component (with Radix UI)

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.


📄 License

MIT License - see LICENSE for details.


🔗 Links


📋 Project Structure

tezosx-ui/
├── src/
│   ├── app/                  # Next.js App Router
│   ├── components/ui/        # Registry components
│   ├── lib/                  # Utilities
│   ├── registry/             # Component registry definitions
│   └── content/docs/         # Documentation (MDX)
├── public/                   # Static assets
├── PLAN.md                   # Detailed project plan
├── TODO.md                   # Task tracking
└── README.md                 # This file

Built with ❤️ by Trilitech for the Tezos community

About

Trilitech’s design system for Tezos marketing experiences, built for consistency, accessibility, and scalability.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published