@gravionlabs/helix-shell 22.0.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

@@ -0,0 +1,99 @@
+# @gravionlabs/helix-shell
+
+Angular application shell for [Helix](../../README.md), extending
+[sakai-ng](https://github.com/primefaces/sakai-ng) with
+[NgRx Signal Store](https://ngrx.io/guide/signals) for state management.
+
+## Features
+
+- 🧩 **Layout** — `HelixAppLayout` with topbar, nav rail, status bar, and footer
+- 🔀 **Routing utilities** — `helixRoutesFrom`, `helixMenuLinksFrom`, `helixBreadcrumbsFromRoutes`
+- 🗃️ **NgRx Signal Store** — `LayoutStore` for theme, menu, and dark-mode state
+- 🔐 **Auth & error pages** — login, error, access-denied, not-found, with lazy route config
+- 🚀 **Landing widgets** — hero, features, highlights, pricing, footer sections
+- 📝 **Form infrastructure** — `HelixFormField`, `HelixValidators`, `helixFormErrorMap`
+- 🎨 **Helix + PrimeUIX theming** — Aura / Lara / Nora presets, dark mode via View Transitions
+- 📦 **Standalone components** — no NgModule required
+
+## Installation
+
+```bash
+npm install @gravionlabs/helix-shell
+```
+
+### Peer Dependencies
+
+`@angular/core >=22`, `@ngrx/signals >=21`, `@gravionlabs/helix-core >=22`,
+`primeicons >=7`.
+
+## Setup
+
+```typescript
+// app.config.ts
+import { auraPreset } from '@gravionlabs/helix-core/themes/aura';
+import { provideHelix } from '@gravionlabs/helix-core/config';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideRouter(appRoutes),
+    provideHttpClient(),
+    provideHelix({ theme: { preset: auraPreset, options: { darkModeSelector: '.app-dark' } } })
+  ]
+};
+```
+
+```typescript
+// app.routes.ts
+import { HelixAppLayout } from '@gravionlabs/helix-shell';
+
+export const appRoutes: Routes = [
+  {
+    path: '',
+    component: HelixAppLayout,
+    children: [/* your routes */]
+  }
+];
+```
+
+## Styles
+
+Some components use Tailwind utility classes baked into their templates. The
+library ships a prebuilt stylesheet covering those classes — add it to your
+app's global styles, since Tailwind's content scanning does not look inside
+`node_modules` by default:
+
+```json
+// angular.json
+"styles": [
+  "node_modules/@gravionlabs/helix-shell/styles.css",
+  "src/styles.scss"
+]
+```
+
+## Layout Store
+
+```typescript
+import { inject } from '@angular/core';
+import { LayoutStore } from '@gravionlabs/helix-shell';
+
+layoutStore = inject(LayoutStore);
+layoutStore.toggleDarkMode();
+layoutStore.setMenuMode('overlay');
+```
+
+## Documentation
+
+Full API reference — every component, input, store signal, and form utility —
+lives in [docs/HELIX-SHELL.md](../../docs/HELIX-SHELL.md).
+
+## Development
+
+```bash
+pnpm start                # Serve the demo app (builds libs first)
+ng build shell      # Build the library
+pnpm test:lib:stable      # Run the shell unit tests
+```
+
+## License
+
+MIT