steadymeet-ui 0.1.1 → 0.1.2
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 +1 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,30 +60,11 @@ Colours are CSS variables prefixed `--steadymeet-`, so they can't clash with an
|
|
|
60
60
|
|
|
61
61
|
## Rules for screens built on the kit
|
|
62
62
|
|
|
63
|
-
- Build from the kit, never raw `<button>`, `<input>` or hex colours.
|
|
63
|
+
- Build from the kit, never raw `<button>`, `<input>` or hex colours.
|
|
64
64
|
- While data loads, show skeletons shaped like the content, inside a `SkeletonGroup` with a translated label. Never a bare "Loading…".
|
|
65
65
|
- Every list or table has an empty state and an error state (`ErrorState`).
|
|
66
66
|
- Text is passed in as props (`label`, `previousLabel`…), so the app translates it. The kit has no locale of its own.
|
|
67
67
|
|
|
68
|
-
## Developing
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
npm test -w steadymeet-ui # unit tests (node:test)
|
|
72
|
-
npm run typecheck -w steadymeet-ui
|
|
73
|
-
npm run lint -w steadymeet-ui
|
|
74
|
-
npm run build -w steadymeet-ui # the publishable package, in dist/
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
Inside the monorepo the apps use `src/` directly, so there is nothing to build while developing. `npm run build` writes `dist/`: compiled JavaScript (with each file's `'use client'` kept), type declarations, the styles and a `package.json` pointing at them.
|
|
78
|
-
|
|
79
|
-
### Publishing
|
|
80
|
-
|
|
81
|
-
1. Raise `version` in `package.json` (semver: a breaking change to a component's props or a renamed token is a major).
|
|
82
|
-
2. `npm run build -w steadymeet-ui`
|
|
83
|
-
3. `npm publish ./packages/ui/dist` (signed in with `npm login`). Publish `dist`, never `packages/ui`: that folder is marked private so it can't be published by mistake.
|
|
84
|
-
|
|
85
|
-
The kit must not import app code (APIs, locales, routers, workspace state). Anything that needs app code stays in the app: SteadyMeet keeps its avatars, presence, emoji and stickers in `apps/web/components/ui`.
|
|
86
|
-
|
|
87
68
|
## License
|
|
88
69
|
|
|
89
70
|
MIT. See [LICENSE](./LICENSE).
|