README.md28 lines · main
1# `packages/ui`
2
3Briven's shared React component library. Built on [Radix UI](https://www.radix-ui.com/) primitives and [shadcn/ui](https://ui.shadcn.com/), styled with Tailwind CSS, and used across all Briven apps.
4
5## Usage
6
7Import from the `'ui'` package alias:
8
9```tsx
10import { Badge, Button, Input } from 'ui'
11```
12
13Some of the components have the `_Shadcn_` suffix. These components should be preferred, they're in a process of replacing the other ones.
14
15### Utilities
16
17```tsx
18// deep object merge (used for themes)
19import { clipboard, cn, mergeDeep } from 'ui' // clsx + tailwind-merge
20
21// copy-to-clipboard helper
22```
23
24## Styling conventions
25
26- Tailwind only — no inline styles or CSS modules.
27- Use semantic tokens (`bg-muted`, `text-foreground-light`, `border-default`) rather than hardcoded colors.
28- The workspace root owns the actual `tailwind.config.js`. The file in this package is a stub for IntelliSense only.
Preview

packages/ui

Briven's shared React component library. Built on Radix UI primitives and shadcn/ui, styled with Tailwind CSS, and used across all Briven apps.

Usage

Import from the 'ui' package alias:

import { Badge, Button, Input } from 'ui'

Some of the components have the _Shadcn_ suffix. These components should be preferred, they're in a process of replacing the other ones.

Utilities

// deep object merge (used for themes)
import { clipboard, cn, mergeDeep } from 'ui' // clsx + tailwind-merge

// copy-to-clipboard helper

Styling conventions

  • Tailwind only — no inline styles or CSS modules.
  • Use semantic tokens (bg-muted, text-foreground-light, border-default) rather than hardcoded colors.
  • The workspace root owns the actual tailwind.config.js. The file in this package is a stub for IntelliSense only.