@noey-17/yearn-ui 0.7.0 → 0.7.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 +6 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,11 @@
|
|
|
1
1
|
# yearn-ui
|
|
2
2
|
|
|
3
|
-
React component library
|
|
3
|
+
React component library. Published to npm.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
You'll need to authenticate with GitHub Packages first. Add a `.npmrc` to your project:
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
@noahhendrickson:registry=https://npm.pkg.github.com
|
|
15
|
-
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
|
|
8
|
+
npm install @noey-17/yearn-ui
|
|
16
9
|
```
|
|
17
10
|
|
|
18
11
|
## Setup
|
|
@@ -22,7 +15,7 @@ You'll need to authenticate with GitHub Packages first. Add a `.npmrc` to your p
|
|
|
22
15
|
Add this once in your app entry point (e.g. `main.jsx`):
|
|
23
16
|
|
|
24
17
|
```js
|
|
25
|
-
import '@
|
|
18
|
+
import '@noey-17/yearn-ui/style.css'
|
|
26
19
|
```
|
|
27
20
|
|
|
28
21
|
This provides Tailwind's base styles and all pre-built utility classes used by the components. Without it, components will render unstyled.
|
|
@@ -32,7 +25,7 @@ This provides Tailwind's base styles and all pre-built utility classes used by t
|
|
|
32
25
|
If you want to use the design tokens in your own components:
|
|
33
26
|
|
|
34
27
|
```js
|
|
35
|
-
import '@
|
|
28
|
+
import '@noey-17/yearn-ui/theme.css'
|
|
36
29
|
```
|
|
37
30
|
|
|
38
31
|
This exposes CSS variables like `--color-bg-primary`, `--color-border-brand`, `--font-body`, etc.
|
|
@@ -42,7 +35,7 @@ This exposes CSS variables like `--color-bg-primary`, `--color-border-brand`, `-
|
|
|
42
35
|
## Usage
|
|
43
36
|
|
|
44
37
|
```jsx
|
|
45
|
-
import { Button, Input, Select, Modal } from '@
|
|
38
|
+
import { Button, Input, Select, Modal } from '@noey-17/yearn-ui'
|
|
46
39
|
|
|
47
40
|
export function Example() {
|
|
48
41
|
return (
|
|
@@ -63,6 +56,7 @@ export function Example() {
|
|
|
63
56
|
| `MultiSelect` | Multi-value dropdown with checkboxes, search, and bulk actions |
|
|
64
57
|
| `Menu` | Dropdown menu container |
|
|
65
58
|
| `MenuItem` | Individual menu option with optional check state |
|
|
59
|
+
| `DropdownMenuItem` | Menu item styled for dropdown context |
|
|
66
60
|
| `Modal` | Dialog overlay with header, body, and footer slots |
|
|
67
61
|
| `Spinner` | Loading indicator |
|
|
68
62
|
| `cx` | Utility for conditional class merging (re-exported from `tailwind-merge`) |
|