@neuralytics/alpine-ds 0.2.3 → 0.2.4
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/CHANGELOG.md +6 -0
- package/README.md +24 -3
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -4,15 +4,22 @@
|
|
|
4
4
|
|
|
5
5
|
## Documentation
|
|
6
6
|
|
|
7
|
-
Component playground (Histoire): -
|
|
8
|
-
|
|
9
7
|
Changelog: [CHANGELOG.md](./CHANGELOG.md)
|
|
10
8
|
|
|
9
|
+
Component playground (Histoire): not published yet.
|
|
10
|
+
|
|
11
|
+
For monorepo-level docs (setup, architecture, contribution workflow), see the [repository README](https://github.com/neuralytics/alpine-design-system#readme).
|
|
12
|
+
|
|
11
13
|
## Components already available
|
|
12
14
|
|
|
13
15
|
- `AlpineButton`
|
|
14
16
|
- `AlpineIcon`
|
|
15
17
|
|
|
18
|
+
## Prerequisites
|
|
19
|
+
|
|
20
|
+
- `vue` ^3.5.25
|
|
21
|
+
- `tailwindcss` ^4.1.17
|
|
22
|
+
|
|
16
23
|
## Integration
|
|
17
24
|
|
|
18
25
|
1. Install the package: `pnpm add @neuralytics/alpine-ds`
|
|
@@ -78,4 +85,18 @@ This only affects the primary button's text (not disabled or loading states) and
|
|
|
78
85
|
import { AlpineButton } from "@neuralytics/alpine-ds"
|
|
79
86
|
```
|
|
80
87
|
|
|
81
|
-
|
|
88
|
+
## Colors
|
|
89
|
+
|
|
90
|
+
The Design System uses the following Tailwind colors:
|
|
91
|
+
|
|
92
|
+
- `gray` (aliased to Tailwind's `neutral` scale)
|
|
93
|
+
- `red`
|
|
94
|
+
- `yellow` (aliased to Tailwind's `amber` scale)
|
|
95
|
+
- `green`
|
|
96
|
+
- `blue`
|
|
97
|
+
- `accent` (required)
|
|
98
|
+
|
|
99
|
+
These are the only colors available: any other Tailwind color utility (e.g. `bg-purple-500`) will not generate any CSS.
|
|
100
|
+
|
|
101
|
+
Note that all colors use 10 shades: `50`, `100`, `200`, ..., `900`.
|
|
102
|
+
`accent` must be provided by the consumer via `setAccentColorTheme` (see step 6 of [Integration](#integration)); the other colors already have a default value.
|