@cyclone-ui/helpers 0.3.26 → 0.3.28
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 +42 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
# Changelog for Cyclone UI - Helpers
|
|
4
4
|
|
|
5
|
+
## [0.3.27](https://github.com/storm-software/cyclone-ui/releases/tag/helpers%400.3.27) (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.3.25](https://github.com/storm-software/cyclone-ui/releases/tag/helpers%400.3.25) (10/22/2026)
|
|
6
12
|
|
|
7
13
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -47,7 +47,9 @@ A package containing various helper utilities used in Storm Software application
|
|
|
47
47
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
48
48
|
## Table of Contents
|
|
49
49
|
|
|
50
|
+
- [Quick Features](#quick-features)
|
|
50
51
|
- [Installing](#installing)
|
|
52
|
+
- [Usage](#usage)
|
|
51
53
|
- [Reduced Package Size](#reduced-package-size)
|
|
52
54
|
- [Development](#development)
|
|
53
55
|
- [Building](#building)
|
|
@@ -65,6 +67,17 @@ A package containing various helper utilities used in Storm Software application
|
|
|
65
67
|
|
|
66
68
|
<!-- END doctoc -->
|
|
67
69
|
|
|
70
|
+
## Quick Features
|
|
71
|
+
|
|
72
|
+
- Size, space, and radius helpers that read Tamagui tokens (`getSized`,
|
|
73
|
+
`getSpaced`, `getRadius`)
|
|
74
|
+
- Token value normalization, including Tailwind-style arbitrary values such as
|
|
75
|
+
`[12px]`
|
|
76
|
+
- Font size and font weight helpers for `styled.dynamic` variants
|
|
77
|
+
- Form control sizes (`sm`, `md`, `lg`) and the shared form-control context
|
|
78
|
+
with hooks for fields
|
|
79
|
+
- Color palette generators based on the OKLCH color space
|
|
80
|
+
|
|
68
81
|
## Installing
|
|
69
82
|
|
|
70
83
|
Using [pnpm](http://pnpm.io):
|
|
@@ -91,9 +104,34 @@ yarn add -D @cyclone-ui/helpers
|
|
|
91
104
|
|
|
92
105
|
</details>
|
|
93
106
|
|
|
107
|
+
## Usage
|
|
108
|
+
|
|
109
|
+
Build a size variant for a Tamagui styled component:
|
|
110
|
+
|
|
111
|
+
```tsx
|
|
112
|
+
import { styled, View } from "@tamagui/core";
|
|
113
|
+
import {
|
|
114
|
+
formSizeVariants,
|
|
115
|
+
getFormFontSize,
|
|
116
|
+
getFormSizeToken
|
|
117
|
+
} from "@cyclone-ui/helpers";
|
|
118
|
+
|
|
119
|
+
export const Box = styled(View, {
|
|
120
|
+
variants: {
|
|
121
|
+
size: formSizeVariants((size, env) => ({
|
|
122
|
+
height: getFormSizeToken(size),
|
|
123
|
+
...getFormFontSize(size, env)
|
|
124
|
+
}))
|
|
125
|
+
}
|
|
126
|
+
});
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
See the [package documentation](../../docs/packages/helpers.md) for every
|
|
130
|
+
export.
|
|
131
|
+
|
|
94
132
|
## Reduced Package Size
|
|
95
133
|
|
|
96
|
-
This project uses [
|
|
134
|
+
This project uses [tsdown](https://tsdown.dev/) to package the source code
|
|
97
135
|
due to its ability to remove unused code and ship smaller javascript files
|
|
98
136
|
thanks to code splitting. This helps to greatly reduce the size of the package
|
|
99
137
|
and to make it easier to use in other projects.
|
|
@@ -103,6 +141,9 @@ and to make it easier to use in other projects.
|
|
|
103
141
|
This project is built using [Nx](https://nx.dev). As a result, many of the usual
|
|
104
142
|
commands are available to assist in development.
|
|
105
143
|
|
|
144
|
+
To set up a checkout, clone the repository and run `pnpm install` in the
|
|
145
|
+
repository root.
|
|
146
|
+
|
|
106
147
|
### Building
|
|
107
148
|
|
|
108
149
|
Run `nx build helpers` to build the library.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cyclone-ui/helpers",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.28",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A repository containing the core front-end components used by Storm Software across many platforms",
|
|
6
6
|
"repository": {
|
|
@@ -185,5 +185,5 @@
|
|
|
185
185
|
"publishConfig": { "access": "public" },
|
|
186
186
|
"module": "./dist/index.mjs",
|
|
187
187
|
"peerDependencies": { "react": "^19.3.1" },
|
|
188
|
-
"gitHead": "
|
|
188
|
+
"gitHead": "03de2f40ce90a524503d0213e72021d8667c3c24"
|
|
189
189
|
}
|