@cyclone-ui/theme-builder 0.0.16 → 0.0.17
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 +38 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
# Changelog for Cyclone UI - Theme Builder
|
|
4
4
|
|
|
5
|
+
## [0.0.17](https://github.com/storm-software/cyclone-ui/releases/tag/theme-builder%400.0.17) (10/23/2026)
|
|
6
|
+
|
|
7
|
+
### Documentation
|
|
8
|
+
|
|
9
|
+
- **monorepo:** Added `sourcebook` skills and partially generated docs for design system ([0dbff145](https://github.com/storm-software/cyclone-ui/commit/0dbff145))
|
|
10
|
+
|
|
5
11
|
## [0.0.15](https://github.com/storm-software/cyclone-ui/releases/tag/theme-builder%400.0.15) (10/22/2026)
|
|
6
12
|
|
|
7
13
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -50,7 +50,9 @@ A package containing the theme building utilities and shared code used by the Cy
|
|
|
50
50
|
|
|
51
51
|
- [Cyclone UI - Theme Builder](#cyclone-ui---theme-builder)
|
|
52
52
|
- [Table of Contents](#table-of-contents)
|
|
53
|
+
- [Quick Features](#quick-features)
|
|
53
54
|
- [Installing](#installing)
|
|
55
|
+
- [Usage](#usage)
|
|
54
56
|
- [Reduced Package Size](#reduced-package-size)
|
|
55
57
|
- [Development](#development)
|
|
56
58
|
- [Building](#building)
|
|
@@ -68,6 +70,14 @@ A package containing the theme building utilities and shared code used by the Cy
|
|
|
68
70
|
|
|
69
71
|
<!-- END doctoc -->
|
|
70
72
|
|
|
73
|
+
## Quick Features
|
|
74
|
+
|
|
75
|
+
- A Razorwind preprocessor that converts token colors to hex and generates
|
|
76
|
+
secondary, `on-*`, state, and focus ring colors for each color group
|
|
77
|
+
- A Razorwind generator that wraps the Tamagui generator with Cyclone UI
|
|
78
|
+
defaults and output fixes
|
|
79
|
+
- Used by the Cyclone CLI `build` and `build-tokens` commands
|
|
80
|
+
|
|
71
81
|
## Installing
|
|
72
82
|
|
|
73
83
|
Using [pnpm](http://pnpm.io):
|
|
@@ -94,9 +104,33 @@ yarn add -D @cyclone-ui/theme-builder
|
|
|
94
104
|
|
|
95
105
|
</details>
|
|
96
106
|
|
|
107
|
+
## Usage
|
|
108
|
+
|
|
109
|
+
Add both plugins to the `plugins` list in `razorwind.config.ts`:
|
|
110
|
+
|
|
111
|
+
```ts
|
|
112
|
+
import { defineConfig } from "@razorwind/core";
|
|
113
|
+
import { generate, preprocessor } from "@cyclone-ui/theme-builder";
|
|
114
|
+
|
|
115
|
+
export default defineConfig({
|
|
116
|
+
name: "cyclone-ui",
|
|
117
|
+
tokensPath: "packages/tokens/src/tokens/**/*.json",
|
|
118
|
+
plugins: [
|
|
119
|
+
preprocessor(),
|
|
120
|
+
generate({
|
|
121
|
+
importConfig: "./default-config",
|
|
122
|
+
outputPath: "packages/tokens/src/tamagui/config.ts"
|
|
123
|
+
})
|
|
124
|
+
]
|
|
125
|
+
});
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
See the [package documentation](../../docs/packages/theme-builder.md) for the
|
|
129
|
+
details of each plugin.
|
|
130
|
+
|
|
97
131
|
## Reduced Package Size
|
|
98
132
|
|
|
99
|
-
This project uses [
|
|
133
|
+
This project uses [tsdown](https://tsdown.dev/) to package the source code
|
|
100
134
|
due to its ability to remove unused code and ship smaller javascript files
|
|
101
135
|
thanks to code splitting. This helps to greatly reduce the size of the package
|
|
102
136
|
and to make it easier to use in other projects.
|
|
@@ -106,6 +140,9 @@ and to make it easier to use in other projects.
|
|
|
106
140
|
This project is built using [Nx](https://nx.dev). As a result, many of the usual
|
|
107
141
|
commands are available to assist in development.
|
|
108
142
|
|
|
143
|
+
To set up a checkout, clone the repository and run `pnpm install` in the
|
|
144
|
+
repository root.
|
|
145
|
+
|
|
109
146
|
### Building
|
|
110
147
|
|
|
111
148
|
Run `nx build theme-builder` to build the library.
|