Skip to content

aryanony/uibrium

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Uibrium β€” Build Smarter. Ship Faster.

Uibrium Logo

npm (scoped) CI License: MIT Docs Storybook PRs Welcome GitHub stars GitHub forks

Uibrium is a premium, open-source React design system and component library that marries couture design with rock-solid engineering. It delivers high-fidelity user experiences with deterministic UI integrity, balancing beauty and performance in every element. With Uibrium, developers get a modular, themable toolkit built on industry best-practices.

Highlights

  • 🎯 Accessible Primitives: Built on Radix UI for 100% WAI-ARIA compliance. All base elements (buttons, inputs, etc.) are fully accessible from day one.
  • 🎨 Tailwind-Driven Styling: Utility-first classes with a pure HSL design token palette, ensuring consistency. You get all of Tailwind’s power and a custom, premium color system.
  • ⚑ Sensory Animations: Breathtaking motion with Framer Motion and magnetic β€œsensory engineering” (custom cursor, loaders, etc.), adding polished micro-interactions to your UI.
  • πŸ”€ Tree-Shaking Ready: Exports optimized ESM and CJS bundles (with sideEffects: false), so unused code is dropped in production builds. Every component is fully typed in TypeScript.
  • 🌐 Theming: Built-in light/dark themes using CSS variables. Swap or extend themes easily, leveraging Uibrium’s HSL token API.
  • πŸ€– Automated Documentation: Fully automated Storybook story generation. Simply create a component, and the sanctuary handles the documentation for you.
  • 🌍 Open Source: Premium design accessible to all. Contributions are welcome – see Contributing.

Installation

Install via npm, yarn or pnpm (Uibrium uses @uibrium/ui as the package name) along with its peer dependencies:

# Using pnpm (recommended)
pnpm add @uibrium/ui framer-motion lucide-react

# Using npm
npm install @uibrium/ui framer-motion lucide-react

# Using yarn
yarn add @uibrium/ui framer-motion lucide-react

Quick Start

Import Uibrium’s components and styles in your app. Wrap your app in the <ThemeProvider> to enable theming, and add the <CustomCursor> for Uibrium’s signature cursor effect (optional).

import React from 'react';
import { Button, CustomCursor, ThemeProvider } from '@uibrium/ui';
import '@uibrium/ui/styles.css';

export default function App() {
  return (
    <ThemeProvider>
      <CustomCursor />
      <Button variant="primary" size="lg">
        Initiate Equilibrium
      </Button>
    </ThemeProvider>
  );
}

This renders a styled primary button in large size. The ThemeProvider ensures all components use Uibrium’s theme tokens, and CustomCursor adds the premium cursor animation.

Components List

Uibrium features a comprehensive set of 19+ premium components:

Component Status Component Status
Accordion βœ… Available Dropdown Menu βœ… Available
Alert βœ… Available Input βœ… Available
Avatar βœ… Available Modal/Dialog βœ… Available
Badge βœ… Available Pagination βœ… Available
Button βœ… Available Radio Group βœ… Available
Card βœ… Available Select βœ… Available
Checkbox βœ… Available Switch βœ… Available
Custom Cursor βœ… Available Table βœ… Available
Drawer βœ… Available Tabs βœ… Available
Tooltip βœ… Available Textarea βœ… Available

Local Development

Want to run the project locally? Follow these steps:

# Clone the repository
git clone https://github.com/aryanony/uibrium.git
cd uibrium

# Install dependencies using pnpm
pnpm install

# Start the component library in watch mode
pnpm dev

# Start the docs site locally
pnpm dev:docs

# Start Storybook
pnpm storybook

Architecture

Uibrium is organized as a monorepo (using PNPM Workspaces and Turborepo) to separate the core library from the docs site while allowing seamless development:

uibrium/
β”œβ”€β”€ packages/ui/       # Core component library (Vite + TypeScript)
β”œβ”€β”€ apps/docs/         # Documentation site (Next.js on Vercel)
β”œβ”€β”€ .storybook/        # Storybook configuration
β”œβ”€β”€ .github/           # CI/CD, issue templates, security policy
β”œβ”€β”€ .changeset/        # Versioning & changelog automation
└── turbo.json         # Turborepo task orchestration
  • /packages/ui – The core component library. Contains all components, styles, tokens, and build configs. Built with Vite (library mode) and TypeScript.
  • /apps/docs – The documentation site (Next.js). It consumes @uibrium/ui directly from the repo so that demos always use the latest changes.

Theming

Uibrium comes with default light and dark themes. All component styles use CSS variables for colors, spacing, fonts, etc. To customize, override the token values in your own CSS or extend the <ThemeProvider>. For example, swap the primary color hue by updating --ui-primary-hue in CSS. Because Uibrium uses HSL tokens under the hood, color adjustments affect the entire palette gracefully.

Roadmap

Check out our ROADMAP.md to see what we're working on next. You can also view our GitHub Projects Board for real-time progress tracking.

Discussions & Community

Have a question? Want to share what you've built? Join our GitHub Discussions!

  • πŸ“£ Announcements
  • πŸ’‘ Component Requests
  • πŸ™‹ Introductions
  • πŸŽ‰ Show and Tell

Contributing

Uibrium is 100% open source under the MIT License. Every contribution helps raise the baseline for developer tooling!

We welcome all types of contributions, from fixing typos to building new components. Check out our Good First Issues to get started!

πŸŽ“ First time contributing to open source? We have a dedicated Beginner Contributor Guide that walks you through making your first pull request step-by-step!

Please read our full CONTRIBUTING.md guide before opening a PR.

Contributors

Thanks to everyone who has contributed! πŸŽ‰

Contributors

Security

Please report security vulnerabilities responsibly. See our Security Policy for details.

Code of Conduct

We are committed to providing a welcoming community. Please read our Code of Conduct.

License

Released under the MIT License. See LICENSE for details.


Created by Aaryan Gupta · Made with ❀️ by the UiBrium community · Build smarter, ship faster.

About

repo: **UiBrium** is a premium, open-source design system and React component library engineered for high-fidelity user experiences and deterministic UI integrity. It bridges the gap between high-end "couture" aesthetics and rigid technical standards. [**Explore Documentation**](https://uibrium.vercel.app)

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors