@thesage/ui 0.0.10 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Sage UI
|
|
2
|
+
|
|
3
|
+
**The Solopreneur's Development Stack.**
|
|
4
|
+
|
|
5
|
+
`@thesage/ui` is the core component library for the Sage ecosystem. It provides a comprehensive set of accessible, reusable, and composable UI components built on top of Radix UI and Tailwind CSS.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- 🎨 **Systematic Design**: Built on a robust token system for consistent implementation.
|
|
10
|
+
- ♿ **Accessible**: rigorous adherence to WAI-ARIA standards (via Radix UI).
|
|
11
|
+
- 🌓 **Dark Mode**: First-class support for light and dark themes.
|
|
12
|
+
- 🧩 **Composable**: components are designed to be composed together to build complex interfaces.
|
|
13
|
+
- 🚀 **Performance**: Exported as tree-shakeable ESM modules.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @thesage/ui
|
|
19
|
+
# or
|
|
20
|
+
pnpm add @thesage/ui
|
|
21
|
+
# or
|
|
22
|
+
yarn add @thesage/ui
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { Button } from '@thesage/ui';
|
|
29
|
+
|
|
30
|
+
export default function MyComponent() {
|
|
31
|
+
return (
|
|
32
|
+
<Button variant="primary" onClick={() => console.log('Clicked!')}>
|
|
33
|
+
Hello World
|
|
34
|
+
</Button>
|
|
35
|
+
);
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Documentation
|
|
40
|
+
|
|
41
|
+
For full documentation, component examples, and guides, visit **[thesage.dev](https://thesage.dev)**.
|
|
42
|
+
|
|
43
|
+
## License
|
|
44
|
+
|
|
45
|
+
MIT © [Shalom Ormsby](https://github.com/shalomormsby)
|