Skip to content

lemu/tide-ui

Repository files navigation

Tide UI

A comprehensive React component library built with Tailwind CSS and Radix UI primitives, designed for internal company use with a focus on design consistency and developer experience.

Features

  • 🎨 Design System First - Built with semantic design tokens and CSS variables
  • Modern Stack - React 18+, TypeScript, Tailwind CSS v4, Radix UI primitives
  • 📦 Tree Shakeable - Import only the components you need
  • 🔧 Developer Experience - Full TypeScript support with comprehensive type definitions
  • 📚 Interactive Documentation - Storybook playground for all components
  • Accessible - Built on Radix UI primitives with accessibility in mind

Installation

npm install @rafal.lemieszewski/tide-ui

Peer Dependencies

Make sure you have React 18+ installed:

npm install react@>=18.0.0 react-dom@>=18.0.0

Setup Tailwind CSS

This library requires Tailwind CSS. Add the preset to your tailwind.config.js:

module.exports = {
  presets: [
    // Add Tide UI preset here when available
  ],
  content: [
    "./src/**/*.{js,ts,jsx,tsx}",
    "./node_modules/@rafal.lemieszewski/tide-ui/**/*.{js,ts,jsx,tsx}",
  ],
  // ... rest of your config
}

Quick Start

import { Button, Card, CardContent, Badge } from '@rafal.lemieszewski/tide-ui'

function App() {
  return (
    <Card>
      <CardContent>
        <div className="flex items-center gap-4">
          <Button>Get Started</Button>
          <Badge intent="success">v0.1.0</Badge>
        </div>
      </CardContent>
    </Card>
  )
}

Available Components

Core Components

  • Button - Versatile button component with multiple variants
  • Badge - Status indicators with intent-based styling
  • Card - Container component for content organization
  • Input - Form input with consistent styling
  • Label - Accessible form labels
  • Switch - Toggle switch component
  • Tabs - Tab navigation with multiple sizes
  • Toggle - Toggle button component

Design Tokens

Access design tokens for consistent theming:

import { designTokens } from '@rafal.lemieszewski/tide-ui'

// Use design tokens in your components
const customStyles = {
  backgroundColor: designTokens.colors.backgroundBrand,
  padding: designTokens.spacing.md,
  borderRadius: designTokens.sizing.sm,
}

Development

This library is built using:

  • Vite - Fast build tool and development server
  • Storybook - Component documentation and playground
  • TypeScript - Type safety and better DX
  • Tailwind CSS - Utility-first CSS framework
  • Radix UI - Headless UI components

Available Scripts

# Development
npm run dev              # Start development server
npm run storybook        # Start Storybook

# Building  
npm run build:lib        # Build library for npm
npm run build-storybook  # Build Storybook for deployment

# Quality
npm run lint             # Run ESLint

Documentation

Browser Support

Tide UI supports all modern browsers:

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

License

MIT License - see LICENSE for details.

Contributing

This is an internal library. For bugs and feature requests, please create an issue in the repository.


Built with ❤️ for internal company projects.

About

A comprehensive React component library built with Tailwind CSS and Radix UI primitives

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •