Skip to content

sharansuman/pixelforge-ui

Β 
Β 

Repository files navigation

PixelForge UI

PixelForge UI Cover

License: MIT npm version CI TypeScript

A bold, unapologetic React component library featuring brutalist design elements, aggressive accessibility, and uncompromising type safety.

PixelForge UI brings together industrial-strength design tokens, brutal aesthetics, and production-ready components for applications that demand attention and deliver results.

πŸ”₯ Design Philosophy

  • Bold & Uncompromising - Sharp borders, dramatic shadows, high contrast
  • Accessibility-First - WCAG 2.1 AA compliance built into every component
  • Performance-Driven - Minimal runtime, maximum impact
  • Developer-Focused - Comprehensive TypeScript support and intuitive APIs

πŸ“¦ Packages

Package Description Version Size
@pixelforge-ui/core Design tokens, theme provider, and utilities npm Unpacked Size
@pixelforge-ui/react React components with brutalist design npm Unpacked Size
@pixelforge-ui/icons Brutalist icon set with React components npm Unpacked Size

|

⚑ Quick Start

# Install the React components package
npm install @pixelforge-ui/react @pixelforge-ui/core

# Or with pnpm
pnpm add @pixelforge-ui/react @pixelforge-ui/core
import { Button, Input, Typography, ThemeProvider } from '@pixelforge-ui/react';

function App() {
  return (
    <ThemeProvider defaultMode="system">
      <Typography variant="h1">WELCOME TO PIXELFORGE</Typography>
      <Input 
        label="Email" 
        type="email" 
        placeholder="Enter your email"
        required 
      />
      <Button variant="primary" size="lg">
        GET STARTED
      </Button>
    </ThemeProvider>
  );
}

🎨 Features

Core Capabilities

  • 🎯 TypeScript-First - Complete type safety with intelligent autocompletion
  • πŸŒ™ Dark Mode Ready - Seamless theme switching with system preference detection
  • πŸ“± Responsive Design - Mobile-first approach with brutalist flair
  • 🌳 Tree Shakeable - Import only what you need for optimal bundle sizes
  • ⚑ Performance Optimized - CSS variables for theming, minimal JavaScript runtime

Design System

  • 🎨 Comprehensive Tokens - Colors, typography, spacing, shadows, and motion
  • πŸ”§ Customizable Themes - Override any design token to match your brand
  • πŸ“ Consistent Spacing - Harmonious spacing scale based on design principles
  • 🎭 Brutalist Aesthetics - Bold borders, dramatic shadows, high contrast

Accessibility

  • β™Ώ WCAG 2.1 AA Compliant - Extensively tested with automated and manual audits
  • ⌨️ Keyboard Navigation - Full keyboard support for all interactive components
  • πŸ” Screen Reader Optimized - Proper ARIA attributes and semantic markup
  • 🎯 Focus Management - Clear focus indicators and logical tab order

πŸ—οΈ Components

Core Components

  • Button - Multiple variants with loading states and icon support
  • Input - Text inputs with validation, icons, and helper text
  • Typography - Comprehensive text styling with semantic variants
  • Container - Responsive layout containers with grid system

Advanced Components

  • Modal - Accessible dialogs with focus trapping and backdrop handling
  • Alert - Notification system with toast support and auto-dismiss
  • Card - Content containers with brutalist design elements
  • Badge - Status indicators and labels

Icons

  • Comprehensive Icon Set - Carefully crafted brutalist icons
  • React Components - Tree-shakeable icon imports
  • Customizable - Size, color, and styling props

πŸ› οΈ Development

Prerequisites

  • Node.js 18+
  • pnpm 8+

Setup

# Clone the repository
git clone https://github.com/pixelforge-ui/pixelforge-ui.git
cd pixelforge-ui

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build all packages
pnpm build

# Start Storybook for component development
pnpm storybook

# Run linting and formatting
pnpm lint
pnpm format

Monorepo Structure

pixelforge-ui/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ core/           # Design tokens and theme utilities
β”‚   β”œβ”€β”€ react/          # React components
β”‚   └── icons/          # Icon components
β”œβ”€β”€ stories/            # Storybook stories
β”œβ”€β”€ .github/            # GitHub Actions workflows
└── docs/               # Documentation

πŸ“š Documentation

🌐 Browser Support

  • Chrome 90+
  • Firefox 88+
  • Safari 14+
  • Edge 90+

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Contribution Steps

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and add tests
  4. Run the test suite: pnpm test
  5. Submit a pull request

πŸ“„ License

MIT License - see the LICENSE file for details.

πŸ† Built With

  • TypeScript - Type safety and developer experience
  • React - Component architecture and hooks
  • CSS Modules - Scoped styling with CSS variables
  • Jest & Testing Library - Comprehensive testing suite
  • Storybook - Component development and documentation
  • GitHub Actions - Automated testing and publishing

Made with ❀️ and countless late nights by a developer passionate about bold design and beautiful user experiences.

About

A bold, unapologetic React component library with brutalist design elements, accessibility-first approach, and comprehensive TypeScript support.

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 81.6%
  • CSS 18.2%
  • JavaScript 0.2%