@odougaraujo/brasa-ui 0.1.0 → 0.1.1
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 +70 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# @odougaraujo/brasa-ui
|
|
2
|
+
|
|
3
|
+
CLI to add [brasa.ui](https://brasa-ui.vercel.app) components to your React project — copy-paste style, like shadcn/ui.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @odougaraujo/brasa-ui init
|
|
9
|
+
npx @odougaraujo/brasa-ui add cpf-input
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
### `init`
|
|
15
|
+
|
|
16
|
+
Sets up brasa.ui in your project. Creates a `brasa.json` config and the component directories.
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx @odougaraujo/brasa-ui init
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### `add <name...>`
|
|
23
|
+
|
|
24
|
+
Adds one or more components to your project, including their dependencies (utils, masks, validators).
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx @odougaraujo/brasa-ui add cpf-input
|
|
28
|
+
npx @odougaraujo/brasa-ui add cpf-input cep-input pix-payment
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### `list`
|
|
32
|
+
|
|
33
|
+
Lists all available components from the registry.
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npx @odougaraujo/brasa-ui list
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Available Components
|
|
40
|
+
|
|
41
|
+
**Brazilian:** `cpf-input` · `cnpj-input` · `cep-input` · `currency-brl` · `phone-br` · `state-select`
|
|
42
|
+
|
|
43
|
+
**Payments:** `pix-payment` · `installment-select`
|
|
44
|
+
|
|
45
|
+
**Core:** `button` · `input` · `select` · `card` · `badge` · `alert` · `dialog` · `tabs` · `accordion` · `dropdown` · `tooltip` · `avatar` · `switch` · `separator` · `textarea`
|
|
46
|
+
|
|
47
|
+
**Utils:** `masks` · `validators` · `formatters` · `qrcode`
|
|
48
|
+
|
|
49
|
+
## How It Works
|
|
50
|
+
|
|
51
|
+
1. `init` creates a `brasa.json` with your project's path aliases
|
|
52
|
+
2. `add` fetches component source code from the [brasa.ui registry](https://brasa-ui.vercel.app/r/index.json)
|
|
53
|
+
3. Files are copied into your project with imports rewritten to match your aliases
|
|
54
|
+
4. You own the code — customize freely
|
|
55
|
+
|
|
56
|
+
## Alternative: npm Package
|
|
57
|
+
|
|
58
|
+
If you prefer a compiled package instead of copy-paste:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npm install brasa.ui
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
```tsx
|
|
65
|
+
import { CPFInput, PixPayment } from "brasa.ui";
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@odougaraujo/brasa-ui",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "CLI to add brasa.ui components to your project",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Douglas Araujo <douglasp.araujo96@gmail.com>",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"bin": {
|
|
15
15
|
"brasa-ui": "./dist/index.js"
|
|
16
16
|
},
|
|
17
|
-
"files": ["dist"],
|
|
17
|
+
"files": ["dist", "README.md"],
|
|
18
18
|
"scripts": {
|
|
19
19
|
"build": "tsup",
|
|
20
20
|
"dev": "tsup --watch"
|