@kaufmann-lab/ui 0.1.0

package/README.md

@@ -0,0 +1,64 @@
+# @kaufmann-lab/ui
+
+Shared Angular component library for the Kaufmann frontends. Consumed by Portal
+LATAM, Portal OTD and Portal Star — including the Ionic mobile app, which is
+still Angular underneath.
+
+## Requirements
+
+Angular 22 and TypeScript ~6.0.3. Angular is a peer dependency, so the library
+uses whatever Angular version the host application already has installed. All
+consumers must be on the same Angular major.
+
+## Install
+
+```bash
+pnpm add @kaufmann-lab/ui
+```
+
+## Usage
+
+Every component is standalone — there is no module to import. Add the component
+to the `imports` of whichever component uses it:
+
+```ts
+import { Component } from '@angular/core';
+import { Button } from '@kaufmann-lab/ui';
+
+@Component({
+  selector: 'app-customers',
+  imports: [Button],
+  template: `<kf-button (click)="save()">Save</kf-button>`,
+})
+export class Customers {}
+```
+
+Styles ship compiled inside each component with view encapsulation. Nothing to
+import in `angular.json`, no global stylesheet to wire up.
+
+## Components
+
+### `<kf-button>`
+
+Wraps a native `<button>`, so keyboard handling, focus and form submission work
+as expected. `(click)` bubbles from the inner button — bind it on the host.
+
+| Input | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `variant` | `'primary' \| 'ghost'` | `'primary'` | |
+| `disabled` | `boolean` | `false` | Bare attribute works: `<kf-button disabled>` |
+| `type` | `'button' \| 'submit' \| 'reset'` | `'submit'` | Matches the native default |
+
+```html
+<kf-button (click)="save()">Save</kf-button>
+<kf-button variant="ghost">Cancel</kf-button>
+<kf-button type="button" disabled>Unavailable</kf-button>
+```
+
+Theming is done through a CSS custom property on the host:
+
+```css
+kf-button {
+  --kf-button-accent: #00693e;
+}
+```