starwind 2.0.1 → 3.0.0-beta.2
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/LICENSE +1 -1
- package/README.md +85 -19
- package/dist/index.js +20197 -2132
- package/dist/index.js.map +1 -1
- package/package.json +9 -9
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,47 +1,113 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img alt="Starwind UI" src="https://shieldcn.dev/header/gradient.svg?title=Starwind+UI&mode=dark&theme=blue" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://github.com/starwind-ui/starwind-ui"><img alt="npm + stars" src="https://shieldcn.dev/group/npm/starwind+github/stars/starwind-ui/starwind-ui.svg" /></a>
|
|
7
|
+
<a href="https://www.npmjs.com/package/starwind"><img alt="downloads" src="https://shieldcn.dev/npm/dm/starwind.svg" /></a>
|
|
8
|
+
<a href="https://x.com/boston343builds"><img alt="follow" src="https://shieldcn.dev/x/follow/boston343builds.svg?split=true" /></a>
|
|
9
|
+
</p>
|
|
4
10
|
|
|
5
|
-
**
|
|
11
|
+
**Astro-first, framework-portable UI components you can own.**
|
|
6
12
|
|
|
7
|
-
Starwind UI
|
|
13
|
+
Starwind UI gives you accessible, Tailwind CSS components with Starwind/shadcn-style ergonomics,
|
|
14
|
+
backed by a portable Runtime that powers Astro and React adapters today.
|
|
8
15
|
|
|
9
|
-
|
|
16
|
+
The Starwind CLI is the main way to get started. Initialize a project, add only the components you
|
|
17
|
+
need, and keep the resulting source in your own codebase.
|
|
18
|
+
|
|
19
|
+
**[Get Started →](https://beta.starwind.dev/docs/getting-started/installation/)** |
|
|
20
|
+
**[Explore Components](https://beta.starwind.dev/docs/components/)**
|
|
10
21
|
|
|
11
22
|
## Why Starwind?
|
|
12
23
|
|
|
13
|
-
- **🎯 Own Your Code** — Components
|
|
14
|
-
-
|
|
15
|
-
- **♿ Accessible** — Keyboard
|
|
16
|
-
- **🚀
|
|
17
|
-
- **🛠️ CLI-Powered** —
|
|
24
|
+
- **🎯 Own Your Code** — Components are added to your project so you can customize and extend them.
|
|
25
|
+
- **🌌 Astro First** — A first-class Astro experience with React support from the same behavior foundation.
|
|
26
|
+
- **♿ Accessible** — Keyboard, focus, form, and screen reader behavior are built into the Runtime-backed components.
|
|
27
|
+
- **🚀 Portable Runtime** — Shared DOM behavior powers generated Astro and React adapters.
|
|
28
|
+
- **🛠️ CLI-Powered** — Initialize projects and add only what you need with a simple command-line workflow.
|
|
18
29
|
|
|
19
30
|
## Quick Start
|
|
20
31
|
|
|
21
|
-
|
|
32
|
+
Initialize an Astro project and add a component:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx starwind@beta init --framework astro
|
|
36
|
+
npx starwind@beta add button
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
For React projects, use `--framework react`:
|
|
22
40
|
|
|
23
41
|
```bash
|
|
24
|
-
npx starwind@
|
|
42
|
+
npx starwind@beta init --framework react
|
|
43
|
+
npx starwind@beta add button
|
|
25
44
|
```
|
|
26
45
|
|
|
27
|
-
|
|
46
|
+
You can omit the framework flag to select it interactively.
|
|
47
|
+
|
|
48
|
+
## What the CLI can do
|
|
49
|
+
|
|
50
|
+
### Add components
|
|
28
51
|
|
|
29
52
|
```bash
|
|
30
|
-
npx starwind@
|
|
53
|
+
npx starwind@beta add button dialog
|
|
31
54
|
```
|
|
32
55
|
|
|
56
|
+
Run `add` without component names to browse the available components. The CLI installs required
|
|
57
|
+
dependencies and records the installed components in your Starwind configuration.
|
|
58
|
+
|
|
59
|
+
### Update and remove components
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx starwind@beta update --all --dry-run
|
|
63
|
+
npx starwind@beta remove button
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Use `--dry-run`, `--diff`, and `--view` to inspect updates before changing files.
|
|
67
|
+
|
|
68
|
+
### Find components and documentation
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
npx starwind@beta search button
|
|
72
|
+
npx starwind@beta docs button
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Search can also discover primitive source with `--primitives` and emit JSON with `--json`.
|
|
76
|
+
|
|
77
|
+
### Migrate legacy projects
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
npx starwind@beta migrate
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
This moves legacy Starwind projects to the current Runtime setup.
|
|
84
|
+
|
|
85
|
+
### Work with primitive source
|
|
86
|
+
|
|
87
|
+
Primitive source is available through the advanced `primitives add`, `primitives update`, and
|
|
88
|
+
`primitives list` commands when you need direct control over framework adapter source.
|
|
89
|
+
|
|
90
|
+
### Starwind Pro
|
|
91
|
+
|
|
92
|
+
Use `npx starwind@beta setup` to configure Starwind Pro before adding Pro components or blocks.
|
|
93
|
+
|
|
33
94
|
## AI integration
|
|
34
95
|
|
|
35
96
|
Resources for AI:
|
|
36
97
|
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
98
|
+
- [Starwind Skills](https://beta.starwind.dev/docs/getting-started/skills/)
|
|
99
|
+
- [MCP server](https://beta.starwind.dev/docs/getting-started/mcp/)
|
|
100
|
+
- [llms.txt](https://beta.starwind.dev/llms.txt)
|
|
101
|
+
- [llms-full.txt](https://beta.starwind.dev/llms-full.txt)
|
|
102
|
+
|
|
103
|
+
## Documentation
|
|
104
|
+
|
|
105
|
+
Read the [Starwind documentation](https://beta.starwind.dev/docs/).
|
|
40
106
|
|
|
41
107
|
## Contributing
|
|
42
108
|
|
|
43
|
-
Please read the [contributing guide](/CONTRIBUTING.md).
|
|
109
|
+
Please read the [contributing guide](https://github.com/starwind-ui/starwind-ui/blob/main/CONTRIBUTING.md).
|
|
44
110
|
|
|
45
111
|
## License
|
|
46
112
|
|
|
47
|
-
Licensed under the [MIT license](/LICENSE).
|
|
113
|
+
Licensed under the [MIT license](https://github.com/starwind-ui/starwind-ui/blob/main/LICENSE).
|