Skip to content

Commit 7159dee

Browse files
Address pre-publish review findings for react-ui (#41)
* Address pre-publish review findings for react-ui * docs: install from git until @corbits/react-ui is on npm npm view @corbits/react-ui 404s; do not advertise a registry tarball as the primary install.
1 parent 3b12281 commit 7159dee

3 files changed

Lines changed: 22 additions & 48 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,19 @@ contract — modules that are not exported are internal and may change in any re
1010

1111
## [Unreleased]
1212

13-
### 0.1.0 — first release
13+
### Breaking changes since 0.1.0
14+
15+
- **`AuthLayout` no longer defaults its decorative panel to `DitherCanvas`.** The panel is
16+
now an explicit `panel` slot with no fallback — pass `<DitherCanvas />`,
17+
`<DitherBackground src={...} />`, or any other content. A caller that omitted `panel` to
18+
get the dither canvas for free now gets a bare panel instead.
19+
20+
## [0.1.0] - 2026-09-17
1421

1522
Nothing has been published before this, so the list below is what the surface consists of
1623
rather than what changed.
1724

18-
- **106 public modules** — 89 UI components, 3 block modules, 1 hook and 13 `lib` modules,
25+
- **197 public modules** — 152 UI components, 5 block modules, 16 hooks and 24 `lib` modules,
1926
importable by subpath (`@corbits/react-ui/ui/button`) or from the root. Output is
2027
per-file ESM with matching declarations; the package is side-effect free apart from its
2128
CSS, so either import style bundles only what you used.
@@ -46,21 +53,16 @@ rather than what changed.
4653
`@tanstack/react-query` outside the adapter, and on anything reachable from the root
4754
barrel importing an optional peer.
4855
- **Peer dependencies** — React 18 or 19, `react-dom`, `lucide-react` (0.545 or 1.x),
49-
`sonner`, `@radix-ui/react-dialog` and `@radix-ui/react-slot`.
56+
`sonner`, `@radix-ui/react-dialog`, `@radix-ui/react-dropdown-menu`,
57+
`@radix-ui/react-slot` and `@radix-ui/react-tooltip`.
5058
**`@tanstack/react-query` is optional** — needed only for the TanStack adapter, which is
5159
why that adapter is importable by subpath but absent from the root entry.
5260

53-
### Breaking changes since 0.1.0
54-
55-
- **`AuthLayout` no longer defaults its decorative panel to `DitherCanvas`.** The panel is
56-
now an explicit `panel` slot with no fallback — pass `<DitherCanvas />`,
57-
`<DitherBackground src={...} />`, or any other content. A caller that omitted `panel` to
58-
get the dither canvas for free now gets a bare panel instead.
59-
6061
#### Notes
6162

6263
- The package ships **no `"use client"` directives**. A React Server Components consumer
6364
marks its own client boundary; see the README.
6465
- `lib/chart-geometry` and `lib/chart-palette` are internal and deliberately not exported.
6566

66-
[Unreleased]: https://github.com/corbitsdev/react-ui
67+
[Unreleased]: https://github.com/corbitsdev/react-ui/compare/v0.1.0...HEAD
68+
[0.1.0]: https://github.com/corbitsdev/react-ui/releases/tag/v0.1.0

‎README.md‎

Lines changed: 8 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,24 @@
11
# @corbits/react-ui
22

33
React components for agent and workflow surfaces — chat, runs, schedules, artifacts,
4-
analytics, collections. 106 modules, importable one at a time.
4+
analytics, collections. 197 modules, importable one at a time.
55

66
Licensed LGPL-2.1-only (see `LICENSE`).
77

88
## Install
99

10-
```bash
11-
npm install @corbits/react-ui react react-dom lucide-react sonner @radix-ui/react-dialog @radix-ui/react-slot
12-
```
13-
14-
```bash
15-
pnpm add @corbits/react-ui react react-dom lucide-react sonner @radix-ui/react-dialog @radix-ui/react-slot
16-
```
17-
18-
```bash
19-
yarn add @corbits/react-ui react react-dom lucide-react sonner @radix-ui/react-dialog @radix-ui/react-slot
20-
```
10+
Not published to npm yet.
2111

2212
```bash
23-
bun add @corbits/react-ui react react-dom lucide-react sonner @radix-ui/react-dialog @radix-ui/react-slot
13+
bun add github:corbitsdev/react-ui react react-dom lucide-react sonner @radix-ui/react-dialog @radix-ui/react-dropdown-menu @radix-ui/react-slot @radix-ui/react-tooltip
2414
```
2515

26-
Installing straight from git works too, and is how a consumer picks up an unreleased
27-
commit:
28-
29-
```bash
30-
bun add github:corbitsdev/react-ui
31-
```
32-
33-
The package publishes `dist/` only, so a git install has to build on the way in. That is
34-
what `prepare` (`scripts/prepare.mjs`) is for: when the package has been installed into a
35-
`node_modules` tree and carries no `dist/`, it installs the build toolchain and runs the
36-
build, so the consumer ends up with the same `dist/` a registry tarball would have carried.
37-
It is a no-op when developing this repository, and a no-op when `dist/` already exists.
38-
39-
Do not remove it without also publishing to a registry — the `exports` map points
40-
exclusively at `dist/`, so a git install without a build resolves to files that are not
41-
there, and the error surfaces in the consumer's tree where they cannot fix it.
42-
43-
With **bun**, a git dependency's lifecycle scripts only run if the consumer trusts them:
44-
45-
```json
46-
{ "trustedDependencies": ["@corbits/react-ui"] }
47-
```
16+
Until a registry publish, `npm install @corbits/react-ui` (and the pnpm/yarn/bun
17+
registry equivalents) 404. Git is the install path.
4818

49-
Without that entry bun skips `prepare` silently and the install looks clean until the first
50-
import fails.
19+
The `prepare` hook builds `dist/` on the way in, and under bun that requires
20+
trusting the package's lifecycle scripts
21+
(`trustedDependencies: ["@corbits/react-ui"]`).
5122

5223
React 18 or 19. `@tanstack/react-query` is an **optional** peer, needed only if you use
5324
`createTanstackDataPort()`; components take their data through a `DataPort` and work with

‎package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "@corbits/react-ui",
33
"version": "0.1.0",
44
"description": "React components for agent and workflow surfaces.",
5+
"author": "Sawyer Cutler <sawyer@dirtroad.dev>",
56
"license": "LGPL-2.1-only",
67
"type": "module",
78
"sideEffects": [

0 commit comments

Comments
 (0)