Skip to content

thinh-trinh-duc/brif-ui

Β 
Β 

Repository files navigation

BrifUI

brifui

A modern, accessible React UI component library built with Panda CSS and Radix UI.

npm version license npm downloads

Features

  • 🧱 Brutalist Design: Honest, raw aesthetic with functional simplicity
  • 🌈 Modern Design System: Beautiful, consistent UI components - powered by PandaCSS
  • β™Ώ Accessibility: WCAG 2.1 compliant components - powered by RadixUI
  • 🎨 Customizable: Fully customizable with Panda CSS
  • πŸ” TypeScript: Full type support
  • πŸ“¦ Modular: Import only what you need
  • 🌐 SSR Compatible: Works with Next.js and other SSR frameworks
  • πŸŒ™ Dark Mode: Built-in support for light and dark themes

Installation

# With npm
npm install @brifui/react

# With yarn
yarn add @brifui/react

# With pnpm
pnpm add @brifui/react

Quick Start

import { Button } from '@brifui/react';

function App() {
  return (
    <Button variant="primary">
      Click me
    </Button>
  );
}

Documentation

For complete documentation, visit our documentation website.

Components

BrifUI includes a wide range of components:

  • Inputs: Button, Checkbox, Radio, Select, Slider, Switch, TextField
  • Navigation: Breadcrumb, Link, Menu, Pagination, Tabs
  • Data Display: Accordion, Avatar, Badge, Card, Table, Tag
  • Feedback: Alert, Dialog, Progress, Spinner, Toast
  • Layout: Box, Flex, Grid, Stack
  • Overlay: Drawer, Modal, Popover, Tooltip

... And many more.

Contributing

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

Project Structure

docs/                  # Documentation website
packages/
  β”œβ”€β”€ cli/             # @brifui/cli package
  β”œβ”€β”€ components/      # Component monorepo
  β”‚    β”œβ”€β”€ accordion/  # Individual component packages
  β”‚    β”œβ”€β”€ button/
  β”‚    └── ...
  β”œβ”€β”€ entry/           # Entrypoint of the library
  β”œβ”€β”€ postcss/         # @brifui/postcss package
  β”œβ”€β”€ styled/          # @brifui/styled package
  β”œβ”€β”€ theme/           # @brifui/theme package
  β”œβ”€β”€ types/           # @brifui/types package
  └── utils/           # @brifui/utils package

Development

To set up the development environment:

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

# Install dependencies
yarn

# Start development environment
yarn dev

Run the test suite with:

yarn test

License

MIT

About

🌈 An opinionated, beautiful, fast and modern React UI library.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.3%
  • JavaScript 4.8%
  • Handlebars 1.9%