Skip to content

Commit a18339b

Browse files
committed
scrub: use react components consistently in public docs and tarball each npm package as a github release asset
1 parent a06f1b3 commit a18339b

7 files changed

Lines changed: 34 additions & 12 deletions

File tree

.github/workflows/release.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,20 @@ jobs:
144144
git tag "v$VERSION"
145145
git push --follow-tags
146146
147+
- name: Pack npm tarballs for release assets
148+
if: steps.diff.outputs.changed == 'true' || github.event_name == 'workflow_dispatch'
149+
run: |
150+
mkdir -p .release-assets
151+
(cd packages/ui && npm pack --pack-destination ../../.release-assets)
152+
(cd packages/ui-react && npm pack --pack-destination ../../.release-assets)
153+
ls -la .release-assets/
154+
147155
- name: Create GitHub release
148156
if: steps.diff.outputs.changed == 'true' || github.event_name == 'workflow_dispatch'
149157
uses: softprops/action-gh-release@v3
150158
with:
151159
tag_name: v${{ steps.bump.outputs.version }}
152160
generate_release_notes: true
153161
make_latest: 'true'
162+
files: |
163+
.release-assets/*.tgz

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ No field renames. No glue code. Use the decision tree above to pick the componen
213213

214214
### Pattern 6: Next.js RSC streaming
215215

216-
Server fetches with the secret key, client renders with the wrapper. The API key never crosses the network.
216+
Server fetches with the secret key, client renders with the React component. The API key never crosses the network.
217217

218218
```tsx
219219
// app/page.tsx (Server Component)

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ The server component fetches, the client component renders. The API key never cr
366366
<details>
367367
<summary><strong>Tailwind v3 vs v4 compatibility?</strong></summary>
368368
369-
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on wrappers and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
369+
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on parent layout elements and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
370370
371371
For Tailwind v4 users, the shadcn registry installs a CSS bridge that maps your existing v4 design tokens onto `--roxy-*`. For Tailwind v3 users, set `--roxy-*` directly on `:root`, or write a tiny bridge:
372372
@@ -400,7 +400,7 @@ useEffect(() => {
400400
return <roxy-location-search ref={ref} />;
401401
```
402402
403-
Upgrade to React 19 when you can; the wrappers route everything cleanly.
403+
Upgrade to React 19 when you can; the React components route everything cleanly.
404404
</details>
405405
406406
<details>
@@ -460,7 +460,7 @@ Mock `@roxyapi/sdk` at the network boundary so unit tests do not hit the live AP
460460
<details>
461461
<summary><strong>What if I want to fork or own a component?</strong></summary>
462462
463-
Use the shadcn registry. The registry drops the component source, a wrapper file, and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
463+
Use the shadcn registry. The registry drops the React component source and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
464464
465465
```bash
466466
npx shadcn@latest add https://cdn.jsdelivr.net/gh/RoxyAPI/ui@latest/registry/natal-chart.json

apps/docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@
552552
"name": "Does this work with React, Next.js, Vue, and Svelte?",
553553
"acceptedAnswer": {
554554
"@type": "Answer",
555-
"text": "Yes. The @roxyapi/ui-react package gives typed React wrappers for every component. Vue, Svelte, Angular, Solid, Astro, Qwik, and other frameworks consume the same Lit web components natively without a wrapper. The same components ship to every framework via the catalog at @roxyapi/ui."
555+
"text": "Yes. The @roxyapi/ui-react package ships typed React components for every entry in the catalog. Vue, Svelte, Angular, Solid, Astro, Qwik, and other frameworks consume the same Lit web components natively, no extra install required. The same components ship to every framework via the catalog at @roxyapi/ui."
556556
}
557557
},
558558
{
@@ -712,7 +712,7 @@ <h2 id="faq-title">Frequently asked</h2>
712712
</details>
713713
<details>
714714
<summary>Does this work with React, Next.js, Vue, and Svelte?</summary>
715-
<p>Yes. The <code>@roxyapi/ui-react</code> package ships typed React wrappers. Vue, Svelte, Angular, Solid, Astro, and Qwik consume the same Lit web components natively without a wrapper.</p>
715+
<p>Yes. The <code>@roxyapi/ui-react</code> package ships typed React components for every entry in the catalog. Vue, Svelte, Angular, Solid, Astro, and Qwik consume the same Lit web components natively, no extra install required.</p>
716716
</details>
717717
<details>
718718
<summary>Can I use RoxyAPI UI with shadcn in a Next.js or React app?</summary>

packages/ui-react/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ The server component fetches, the client component renders. The API key never cr
360360
<details>
361361
<summary><strong>Tailwind v3 vs v4 compatibility?</strong></summary>
362362
363-
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on wrappers and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
363+
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on parent layout elements and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
364364
365365
For Tailwind v4 users, the shadcn registry installs a CSS bridge that maps your existing v4 design tokens onto `--roxy-*`. For Tailwind v3 users, set `--roxy-*` directly on `:root`, or write a tiny bridge:
366366
@@ -394,7 +394,7 @@ useEffect(() => {
394394
return <roxy-location-search ref={ref} />;
395395
```
396396
397-
Upgrade to React 19 when you can; the wrappers route everything cleanly.
397+
Upgrade to React 19 when you can; the React components route everything cleanly.
398398
</details>
399399
400400
<details>
@@ -454,7 +454,7 @@ Mock `@roxyapi/sdk` at the network boundary so unit tests do not hit the live AP
454454
<details>
455455
<summary><strong>What if I want to fork or own a component?</strong></summary>
456456
457-
Use the shadcn registry. The registry drops the component source, a wrapper file, and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
457+
Use the shadcn registry. The registry drops the React component source and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
458458
459459
```bash
460460
npx shadcn@latest add https://cdn.jsdelivr.net/gh/RoxyAPI/ui@latest/registry/natal-chart.json

packages/ui/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ The server component fetches, the client component renders. The API key never cr
366366
<details>
367367
<summary><strong>Tailwind v3 vs v4 compatibility?</strong></summary>
368368
369-
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on wrappers and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
369+
Both work. Components do not consume Tailwind utilities. Tailwind utilities apply outside the components on parent layout elements and containers; inside the Shadow DOM, components read `--roxy-*` CSS custom properties only.
370370
371371
For Tailwind v4 users, the shadcn registry installs a CSS bridge that maps your existing v4 design tokens onto `--roxy-*`. For Tailwind v3 users, set `--roxy-*` directly on `:root`, or write a tiny bridge:
372372
@@ -400,7 +400,7 @@ useEffect(() => {
400400
return <roxy-location-search ref={ref} />;
401401
```
402402
403-
Upgrade to React 19 when you can; the wrappers route everything cleanly.
403+
Upgrade to React 19 when you can; the React components route everything cleanly.
404404
</details>
405405
406406
<details>
@@ -460,7 +460,7 @@ Mock `@roxyapi/sdk` at the network boundary so unit tests do not hit the live AP
460460
<details>
461461
<summary><strong>What if I want to fork or own a component?</strong></summary>
462462
463-
Use the shadcn registry. The registry drops the component source, a wrapper file, and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
463+
Use the shadcn registry. The registry drops the React component source and a CSS theme bridge into your repo. Edit anything; the source is yours from that point.
464464
465465
```bash
466466
npx shadcn@latest add https://cdn.jsdelivr.net/gh/RoxyAPI/ui@latest/registry/natal-chart.json

scripts/brand-grep.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,16 @@ const CATEGORY_A_PATTERNS: Pattern[] = [
130130
label: 'forbidden-phrase',
131131
test: ci(/thin\s+(wrapper|shell|shells)/i),
132132
},
133+
{
134+
category: 'A',
135+
label: 'forbidden-phrase',
136+
test: ci(/\b(react|typed)\s+wrappers?\b/i),
137+
},
138+
{
139+
category: 'A',
140+
label: 'forbidden-phrase',
141+
test: ci(/\bwrapper\s+(file|around)\b/i),
142+
},
133143
{
134144
category: 'A',
135145
label: 'forbidden-phrase',
@@ -288,6 +298,8 @@ const EXTRACTION_RES: RegExp[] = [
288298
/jsdelivr\s+UMD/i,
289299
/lazy[-\s]?load(?:s|ing)?/i,
290300
/thin\s+(wrapper|shell|shells)/i,
301+
/\b(react|typed)\s+wrappers?\b/i,
302+
/\bwrapper\s+(file|around)\b/i,
291303
/decoupled\s+release|coordinated\s+release/i,
292304
/no\s+runtime\s+(dependency|deps)/i,
293305
/\bforwardRef\b/,

0 commit comments

Comments
 (0)