@gravionlabs/helix-ui 0.0.0-stage → 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GravionLabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# @gravionlabs/helix-ui
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Vanilla Angular components on the Helix design tokens: standalone, signal-based, plain CSS, no runtime
+styling engine, no dependency on `@gravionlabs/helix-core`. It is the long-term replacement of the vendored
+PrimeNG fork (see [ADR 0001](../../docs/adr/0001-styling-foundation.md), epic #523).
+
+## Install
+
+```bash
+npm install @gravionlabs/helix-ui
+```
+
+```css
+/* the components */
+@import "@gravionlabs/helix-ui/styles.css";
+/* the tokens the components read; load them in every app, also with the helix-core theme engine */
+@import "@gravionlabs/helix-ui/tokens.css";
+```
+
+Dark mode: tokens switch under the `app-dark` class on `<html>`, as in `helix-shell`.
+
+## Components
+
+| Component | Selector | |
+| --- | --- | --- |
+| `HxButton` | `button[hx-button]`, `a[hx-button]` | variants, severities, sizes, loading, icon-only |
+| `HxInput` | `input[hx-input]`, `textarea[hx-input]` | outlined / filled, sizes, invalid |
+| `HxCheckbox` | `input[hx-checkbox]` | native checkbox, indeterminate |
+| `HxRadio` | `input[hx-radio]` | native radio |
+| `HxSelect` | `hx-select` | CDK listbox in an overlay, all three forms APIs |
+| `HxDivider` | `hx-divider` | horizontal/vertical, labelled |
+| `HxTooltip` | `[hx-tooltip]` | CDK overlay, hover and focus |
+| `HxBreadcrumb` | `hx-breadcrumb` | router links, home item |
+| `HxPassword` | `hx-password` | show/hide toggle, all three forms APIs |
+| `HxSelectButton` | `hx-select-button` | single or multiple, all three forms APIs |
+| `HxSwitch` | `input[hx-switch]` | native checkbox with `role="switch"` |
+
+Selectors, inputs and classes use the prefix `hx` (`hx-button`), so they never clash with `helix-core`'s `h-`
+in an app that uses both while migrating. Both libraries read the same `--h-*` tokens, so a page mixes them
+without a visible seam.
+
+## Rules of this package
+
+- Nothing imports `@gravionlabs/helix-core`, `@primeuix/*` or `primeng` (`pnpm lint:no-core`).
+- Styles are plain CSS in `styles/<component>.css` that read `--h-*` tokens only; they ship in a `components`
+  cascade layer so an app's own CSS and Tailwind utilities win without specificity fights.
+- Every component has unit tests and a docs page; a test fails when a stylesheet reads a token that
+  `tokens.css` does not define.
+
+## Publishing
+
+Not published yet: the first release needs a trusted-publisher entry for `@gravionlabs/helix-ui` on npmjs.com
+(Settings → Trusted Publisher → GitHub Actions, owner GravionLabs, repo helix, workflow `ci.yml`), then
+`ui` joins the package loops of `.github/workflows/ci.yml`.
+
+## License
+
+MIT