@codesweep-ai/ui 0.2.1-dev.20260908050525.6194052 → 0.2.1-dev.20260908203434.f9a9f65
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 +16 -16
- package/dist/BUILD.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# @codesweep-ai/ui
|
|
2
2
|
|
|
3
3
|
[](https://github.com/codesweep-ai/ui/actions/workflows/ci.yml)
|
|
4
|
-
[](https://github.com/codesweep-ai/ui/blob/
|
|
4
|
+
[](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/LICENSE)
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
@@ -46,7 +46,7 @@ export function RunStatus() {
|
|
|
46
46
|
}
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
[INSTALL.md](https://github.com/codesweep-ai/ui/blob/
|
|
49
|
+
[INSTALL.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/INSTALL.md) has the rest: the prerequisites, which stylesheets a
|
|
50
50
|
project needs, and the boot script that applies a theme before React paints. To
|
|
51
51
|
look at the components before installing anything, start with the catalogue
|
|
52
52
|
app below.
|
|
@@ -80,9 +80,9 @@ filesystem.
|
|
|
80
80
|
## Finding a component
|
|
81
81
|
|
|
82
82
|
The package ships dozens of components and patterns.
|
|
83
|
-
[CATALOG.md](https://github.com/codesweep-ai/ui/blob/
|
|
83
|
+
[CATALOG.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/CATALOG.md) indexes them by intent, so search it for what you are
|
|
84
84
|
building rather than scanning a list. Each entry links to that component's
|
|
85
|
-
specification under [`components/`](https://github.com/codesweep-ai/ui/tree/
|
|
85
|
+
specification under [`components/`](https://github.com/codesweep-ai/ui/tree/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/components), which holds its props, its
|
|
86
86
|
visual spec, and the DOM hooks it guarantees.
|
|
87
87
|
|
|
88
88
|
The catalogue also gives the order to decide in. Match an entry and compose it,
|
|
@@ -93,11 +93,11 @@ fits.
|
|
|
93
93
|
|
|
94
94
|
Light and dark both ship. `ThemeToggle` renders the control, `useTheme` reads
|
|
95
95
|
and sets the value, and `themeBootScript` applies the stored choice before the
|
|
96
|
-
page paints. [MANUAL.md](https://github.com/codesweep-ai/ui/blob/
|
|
96
|
+
page paints. [MANUAL.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/MANUAL.md) covers all three.
|
|
97
97
|
|
|
98
98
|
The tokens beneath both themes cover colour, space, radius, type and elevation.
|
|
99
99
|
Every one is a CSS custom property, and section 4 of
|
|
100
|
-
[DESIGN_SYSTEM_SPEC.md](https://github.com/codesweep-ai/ui/blob/
|
|
100
|
+
[DESIGN_SYSTEM_SPEC.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/DESIGN_SYSTEM_SPEC.md) lists them. A component
|
|
101
101
|
stylesheet reads tokens and never literal values, which `npm run check`
|
|
102
102
|
enforces.
|
|
103
103
|
|
|
@@ -105,27 +105,27 @@ enforces.
|
|
|
105
105
|
|
|
106
106
|
The documentation lives in the [codesweep-ai/ui](https://github.com/codesweep-ai/ui)
|
|
107
107
|
GitHub repository rather than in this package. Every link below is pinned
|
|
108
|
-
to `
|
|
108
|
+
to `f9a9f6537ba8fc6999623a9f1ff055cf19a95281`, the commit this build came from, so it describes what you
|
|
109
109
|
installed and not whatever `main` holds when you follow it.
|
|
110
110
|
|
|
111
111
|
`catalog.json` is the exception: it ships beside the code. It is the same
|
|
112
112
|
index as `CATALOG.md`, as data, and it cannot disagree with the build it
|
|
113
113
|
came in.
|
|
114
114
|
|
|
115
|
-
- [INSTALL.md](https://github.com/codesweep-ai/ui/blob/
|
|
116
|
-
- [MANUAL.md](https://github.com/codesweep-ai/ui/blob/
|
|
117
|
-
- [CATALOG.md](https://github.com/codesweep-ai/ui/blob/
|
|
118
|
-
- [DESIGN_SYSTEM_SPEC.md](https://github.com/codesweep-ai/ui/blob/
|
|
119
|
-
- [CHANGELOG.md](https://github.com/codesweep-ai/ui/blob/
|
|
120
|
-
- [CONTRIBUTING.md](https://github.com/codesweep-ai/ui/blob/
|
|
121
|
-
- [AGENTS.md](https://github.com/codesweep-ai/ui/blob/
|
|
115
|
+
- [INSTALL.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/INSTALL.md) · getting the package, and the setup it needs once
|
|
116
|
+
- [MANUAL.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/MANUAL.md) · what the package exports, the entry points, theming and the DOM contract
|
|
117
|
+
- [CATALOG.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/CATALOG.md) · every component and pattern, indexed by intent
|
|
118
|
+
- [DESIGN_SYSTEM_SPEC.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/DESIGN_SYSTEM_SPEC.md) · the tokens, the architecture and the conventions
|
|
119
|
+
- [CHANGELOG.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/CHANGELOG.md) · what an upgrade between versions asks of you
|
|
120
|
+
- [CONTRIBUTING.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/CONTRIBUTING.md) · working on the package
|
|
121
|
+
- [AGENTS.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/AGENTS.md) · where an agent looks first
|
|
122
122
|
|
|
123
123
|
## Contributing
|
|
124
124
|
|
|
125
125
|
Bug reports and pull requests are welcome.
|
|
126
|
-
[CONTRIBUTING.md](https://github.com/codesweep-ai/ui/blob/
|
|
126
|
+
[CONTRIBUTING.md](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/CONTRIBUTING.md) says how to work on the package, and applies
|
|
127
127
|
to coding agents as well as to people.
|
|
128
128
|
|
|
129
129
|
## License
|
|
130
130
|
|
|
131
|
-
[Apache-2.0](https://github.com/codesweep-ai/ui/blob/
|
|
131
|
+
[Apache-2.0](https://github.com/codesweep-ai/ui/blob/f9a9f6537ba8fc6999623a9f1ff055cf19a95281/LICENSE).
|
package/dist/BUILD.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"sha":"
|
|
1
|
+
{"sha":"f9a9f6537ba8fc6999623a9f1ff055cf19a95281"}
|
package/package.json
CHANGED