@egose/shadcn-theme-ng-tw 0.1.0 → 0.3.0

package/form-autocomplete/fesm2022/form-autocomplete.mjs

@@ -0,0 +1,211 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, inject, input, computed, Component } from '@angular/core';
+import * as i1 from '@angular/forms';
+import { FormGroupDirective, ReactiveFormsModule, ControlContainer } from '@angular/forms';
+import { HlmFormIdGenerator, HlmFormField, HlmError, HlmHint } from '@egose/shadcn-theme-ng-tw/form-field';
+import { HlmLabel } from '@egose/shadcn-theme-ng-tw/label';
+import { HlmAutocomplete, HlmAutocompleteContent, HlmAutocompleteEmpty, HlmAutocompleteGroup, HlmAutocompleteInput, HlmAutocompleteItem, HlmAutocompleteList, HlmAutocompleteLabel } from '@egose/shadcn-theme-ng-tw/autocomplete';
+import { hlm } from '@egose/shadcn-theme-ng-tw/utils';
+
+const EgFormAutocompleteConfigToken = new InjectionToken('EgFormAutocompleteConfig');
+function provideEgFormAutocompleteConfig(config) {
+    return { provide: EgFormAutocompleteConfigToken, useValue: { ...config } };
+}
+function injectEgFormAutocompleteConfig() {
+    return inject(EgFormAutocompleteConfigToken, { optional: true }) ?? {};
+}
+
+class EgFormAutocomplete {
+    formGroupDirective = inject(FormGroupDirective);
+    generatedId = inject(HlmFormIdGenerator).generate('eg-form-autocomplete');
+    _config = injectEgFormAutocompleteConfig();
+    label = input(undefined, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "label" }] : /* istanbul ignore next */ []));
+    controlId = input(undefined, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "controlId" }] : /* istanbul ignore next */ []));
+    controlName = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "controlName" }] : /* istanbul ignore next */ []));
+    error = input(undefined, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "error" }] : /* istanbul ignore next */ []));
+    hint = input(undefined, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "hint" }] : /* istanbul ignore next */ []));
+    id = input(undefined, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "id" }] : /* istanbul ignore next */ []));
+    placeholder = input('Type to search…', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "placeholder" }] : /* istanbul ignore next */ []));
+    emptyText = input('No result.', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "emptyText" }] : /* istanbul ignore next */ []));
+    disabled = input(false, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "disabled" }] : /* istanbul ignore next */ []));
+    required = input(false, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "required" }] : /* istanbul ignore next */ []));
+    options = input([], /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "options" }] : /* istanbul ignore next */ []));
+    effectiveId = computed(() => this.controlId() || this.id() || this.generatedId, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "effectiveId" }] : /* istanbul ignore next */ []));
+    errorId = computed(() => `${this.effectiveId()}-error`, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "errorId" }] : /* istanbul ignore next */ []));
+    hintId = computed(() => `${this.effectiveId()}-hint`, /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "hintId" }] : /* istanbul ignore next */ []));
+    /**
+     * Combined lock for the brain `linkedSignal`-based disabled state: the raw
+     * input write always carries the resolved value, so a same-pass
+     * wrapper-toggle + `control.disable()` cannot clobber CVA state.
+     */
+    effectiveDisabled() {
+        return this.disabled() || !!this.formGroupDirective.form.get(this.controlName())?.disabled;
+    }
+    // Styling
+    userClass = input('', { ...(ngDevMode ? { debugName: "userClass" } : /* istanbul ignore next */ {}), alias: 'class' });
+    labelClass = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "labelClass" }] : /* istanbul ignore next */ []));
+    controlClass = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "controlClass" }] : /* istanbul ignore next */ []));
+    inputClass = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "inputClass" }] : /* istanbul ignore next */ []));
+    errorClass = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "errorClass" }] : /* istanbul ignore next */ []));
+    hintClass = input('', /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "hintClass" }] : /* istanbul ignore next */ []));
+    // Computed classes (library base < global config < per-instance).
+    // NOTE: the autocomplete input exposes no aria-describedby, so error/hint
+    // ids render without an input-level describedby link.
+    $userClass = computed(() => hlm('tw:w-full', this.userClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$userClass" }] : /* istanbul ignore next */ []));
+    $labelClass = computed(() => hlm('tw:mb-1', this._config.labelClass, this.labelClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$labelClass" }] : /* istanbul ignore next */ []));
+    $controlClass = computed(() => hlm(this._config.controlClass, this.controlClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$controlClass" }] : /* istanbul ignore next */ []));
+    $inputClass = computed(() => hlm(this._config.inputClass, this.inputClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$inputClass" }] : /* istanbul ignore next */ []));
+    $errorClass = computed(() => hlm('tw:mt-0', this._config.errorClass, this.errorClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$errorClass" }] : /* istanbul ignore next */ []));
+    $hintClass = computed(() => hlm('tw:mt-0', this._config.hintClass, this.hintClass()), /* @ts-ignore */
+    ...(ngDevMode ? [{ debugName: "$hintClass" }] : /* istanbul ignore next */ []));
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.3", ngImport: i0, type: EgFormAutocomplete, deps: [], target: i0.ɵɵFactoryTarget.Component });
+    static ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "17.0.0", version: "22.1.3", type: EgFormAutocomplete, isStandalone: true, selector: "eg-form-autocomplete", inputs: { label: { classPropertyName: "label", publicName: "label", isSignal: true, isRequired: false, transformFunction: null }, controlId: { classPropertyName: "controlId", publicName: "controlId", isSignal: true, isRequired: false, transformFunction: null }, controlName: { classPropertyName: "controlName", publicName: "controlName", isSignal: true, isRequired: false, transformFunction: null }, error: { classPropertyName: "error", publicName: "error", isSignal: true, isRequired: false, transformFunction: null }, hint: { classPropertyName: "hint", publicName: "hint", isSignal: true, isRequired: false, transformFunction: null }, id: { classPropertyName: "id", publicName: "id", isSignal: true, isRequired: false, transformFunction: null }, placeholder: { classPropertyName: "placeholder", publicName: "placeholder", isSignal: true, isRequired: false, transformFunction: null }, emptyText: { classPropertyName: "emptyText", publicName: "emptyText", isSignal: true, isRequired: false, transformFunction: null }, disabled: { classPropertyName: "disabled", publicName: "disabled", isSignal: true, isRequired: false, transformFunction: null }, required: { classPropertyName: "required", publicName: "required", isSignal: true, isRequired: false, transformFunction: null }, options: { classPropertyName: "options", publicName: "options", isSignal: true, isRequired: false, transformFunction: null }, userClass: { classPropertyName: "userClass", publicName: "class", isSignal: true, isRequired: false, transformFunction: null }, labelClass: { classPropertyName: "labelClass", publicName: "labelClass", isSignal: true, isRequired: false, transformFunction: null }, controlClass: { classPropertyName: "controlClass", publicName: "controlClass", isSignal: true, isRequired: false, transformFunction: null }, inputClass: { classPropertyName: "inputClass", publicName: "inputClass", isSignal: true, isRequired: false, transformFunction: null }, errorClass: { classPropertyName: "errorClass", publicName: "errorClass", isSignal: true, isRequired: false, transformFunction: null }, hintClass: { classPropertyName: "hintClass", publicName: "hintClass", isSignal: true, isRequired: false, transformFunction: null } }, host: { properties: { "class": "$userClass()" } }, providers: [{ provide: ControlContainer, useExisting: FormGroupDirective }], ngImport: i0, template: `
+    @let lbl = label();
+    @let cnm = controlName();
+    @let err = error();
+    @let hnt = hint();
+    @let rqrd = required();
+
+    <hlm-form-field>
+      @if (lbl) {
+        <label hlmLabel [for]="effectiveId()" [class]="$labelClass()"
+          >{{ lbl }}
+          @if (rqrd) {
+            <span class="tw:text-red-500">*</span>
+          }
+        </label>
+      }
+
+      <div hlmAutocomplete [formControlName]="cnm" [disabled]="effectiveDisabled()" [class]="$controlClass()">
+        <hlm-autocomplete-input [inputId]="effectiveId()" [placeholder]="placeholder()" [class]="$inputClass()" />
+        <hlm-autocomplete-content>
+          <div hlmAutocompleteList>
+            <div hlmAutocompleteGroup>
+              @for (option of options(); track option) {
+                <hlm-autocomplete-item [value]="option">{{ option }}</hlm-autocomplete-item>
+              }
+            </div>
+          </div>
+          <div hlmAutocompleteEmpty>{{ emptyText() }}</div>
+        </hlm-autocomplete-content>
+      </div>
+
+      @if (err) {
+        <hlm-error [id]="errorId()" [class]="$errorClass()">
+          {{ err }}
+        </hlm-error>
+      }
+
+      @if (hnt) {
+        <hlm-hint [id]="hintId()" [class]="$hintClass()">
+          {{ hnt }}
+        </hlm-hint>
+      }
+    </hlm-form-field>
+  `, isInline: true, dependencies: [{ kind: "ngmodule", type: ReactiveFormsModule }, { kind: "directive", type: i1.NgControlStatus, selector: "[formControlName],[ngModel],[formControl]" }, { kind: "directive", type: i1.FormControlName, selector: "[formControlName]", inputs: ["formControlName", "disabled", "ngModel"], outputs: ["ngModelChange"] }, { kind: "component", type: HlmFormField, selector: "hlm-form-field", inputs: ["class"] }, { kind: "directive", type: HlmError, selector: "hlm-error", inputs: ["class"] }, { kind: "directive", type: HlmHint, selector: "hlm-hint", inputs: ["class"] }, { kind: "directive", type: HlmLabel, selector: "[hlmLabel]", inputs: ["class"] }, { kind: "directive", type: HlmAutocomplete, selector: "[hlmAutocomplete],hlm-autocomplete" }, { kind: "directive", type: HlmAutocompleteContent, selector: "[hlmAutocompleteContent],hlm-autocomplete-content" }, { kind: "directive", type: HlmAutocompleteEmpty, selector: "[hlmAutocompleteEmpty],hlm-autocomplete-empty" }, { kind: "directive", type: HlmAutocompleteGroup, selector: "[hlmAutocompleteGroup]" }, { kind: "component", type: HlmAutocompleteInput, selector: "hlm-autocomplete-input", inputs: ["inputId", "placeholder", "showSearch", "showClear", "forceInvalid", "aria-invalid"] }, { kind: "component", type: HlmAutocompleteItem, selector: "hlm-autocomplete-item" }, { kind: "directive", type: HlmAutocompleteList, selector: "[hlmAutocompleteList]" }] });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.3", ngImport: i0, type: EgFormAutocomplete, decorators: [{
+            type: Component,
+            args: [{
+                    selector: 'eg-form-autocomplete',
+                    standalone: true,
+                    host: {
+                        '[class]': '$userClass()',
+                    },
+                    imports: [
+                        ReactiveFormsModule,
+                        HlmFormField,
+                        HlmError,
+                        HlmHint,
+                        HlmLabel,
+                        HlmAutocomplete,
+                        HlmAutocompleteContent,
+                        HlmAutocompleteEmpty,
+                        HlmAutocompleteGroup,
+                        HlmAutocompleteInput,
+                        HlmAutocompleteItem,
+                        HlmAutocompleteLabel,
+                        HlmAutocompleteList,
+                    ],
+                    providers: [{ provide: ControlContainer, useExisting: FormGroupDirective }],
+                    template: `
+    @let lbl = label();
+    @let cnm = controlName();
+    @let err = error();
+    @let hnt = hint();
+    @let rqrd = required();
+
+    <hlm-form-field>
+      @if (lbl) {
+        <label hlmLabel [for]="effectiveId()" [class]="$labelClass()"
+          >{{ lbl }}
+          @if (rqrd) {
+            <span class="tw:text-red-500">*</span>
+          }
+        </label>
+      }
+
+      <div hlmAutocomplete [formControlName]="cnm" [disabled]="effectiveDisabled()" [class]="$controlClass()">
+        <hlm-autocomplete-input [inputId]="effectiveId()" [placeholder]="placeholder()" [class]="$inputClass()" />
+        <hlm-autocomplete-content>
+          <div hlmAutocompleteList>
+            <div hlmAutocompleteGroup>
+              @for (option of options(); track option) {
+                <hlm-autocomplete-item [value]="option">{{ option }}</hlm-autocomplete-item>
+              }
+            </div>
+          </div>
+          <div hlmAutocompleteEmpty>{{ emptyText() }}</div>
+        </hlm-autocomplete-content>
+      </div>
+
+      @if (err) {
+        <hlm-error [id]="errorId()" [class]="$errorClass()">
+          {{ err }}
+        </hlm-error>
+      }
+
+      @if (hnt) {
+        <hlm-hint [id]="hintId()" [class]="$hintClass()">
+          {{ hnt }}
+        </hlm-hint>
+      }
+    </hlm-form-field>
+  `,
+                }]
+        }], propDecorators: { label: [{ type: i0.Input, args: [{ isSignal: true, alias: "label", required: false }] }], controlId: [{ type: i0.Input, args: [{ isSignal: true, alias: "controlId", required: false }] }], controlName: [{ type: i0.Input, args: [{ isSignal: true, alias: "controlName", required: false }] }], error: [{ type: i0.Input, args: [{ isSignal: true, alias: "error", required: false }] }], hint: [{ type: i0.Input, args: [{ isSignal: true, alias: "hint", required: false }] }], id: [{ type: i0.Input, args: [{ isSignal: true, alias: "id", required: false }] }], placeholder: [{ type: i0.Input, args: [{ isSignal: true, alias: "placeholder", required: false }] }], emptyText: [{ type: i0.Input, args: [{ isSignal: true, alias: "emptyText", required: false }] }], disabled: [{ type: i0.Input, args: [{ isSignal: true, alias: "disabled", required: false }] }], required: [{ type: i0.Input, args: [{ isSignal: true, alias: "required", required: false }] }], options: [{ type: i0.Input, args: [{ isSignal: true, alias: "options", required: false }] }], userClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "class", required: false }] }], labelClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "labelClass", required: false }] }], controlClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "controlClass", required: false }] }], inputClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "inputClass", required: false }] }], errorClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "errorClass", required: false }] }], hintClass: [{ type: i0.Input, args: [{ isSignal: true, alias: "hintClass", required: false }] }] } });
+
+/*
+ * Public API Surface of form-autocomplete
+ */
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { EgFormAutocomplete, injectEgFormAutocompleteConfig, provideEgFormAutocompleteConfig };
+

package/form-autocomplete/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "form-autocomplete",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@angular/common": "^20.3.0 || ^22.0.0",
+    "@angular/core": "^20.3.0 || ^22.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/form-autocomplete.mjs",
+  "typings": "types/form-autocomplete.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./types/form-autocomplete.d.ts",
+      "default": "./fesm2022/form-autocomplete.mjs"
+    }
+  },
+  "type": "module"
+}

package/form-autocomplete/types/form-autocomplete.d.ts

@@ -0,0 +1,61 @@
+import * as _angular_core from '@angular/core';
+import { ValueProvider } from '@angular/core';
+import { ClassValue } from 'clsx';
+
+declare class EgFormAutocomplete {
+    private readonly formGroupDirective;
+    private readonly generatedId;
+    private readonly _config;
+    label: _angular_core.InputSignal<string | undefined>;
+    controlId: _angular_core.InputSignal<string | undefined>;
+    controlName: _angular_core.InputSignal<string>;
+    error: _angular_core.InputSignal<string | undefined>;
+    hint: _angular_core.InputSignal<string | undefined>;
+    id: _angular_core.InputSignal<string | undefined>;
+    placeholder: _angular_core.InputSignal<string>;
+    emptyText: _angular_core.InputSignal<string>;
+    disabled: _angular_core.InputSignal<boolean>;
+    required: _angular_core.InputSignal<boolean>;
+    options: _angular_core.InputSignal<string[]>;
+    readonly effectiveId: _angular_core.Signal<string>;
+    readonly errorId: _angular_core.Signal<string>;
+    readonly hintId: _angular_core.Signal<string>;
+    /**
+     * Combined lock for the brain `linkedSignal`-based disabled state: the raw
+     * input write always carries the resolved value, so a same-pass
+     * wrapper-toggle + `control.disable()` cannot clobber CVA state.
+     */
+    effectiveDisabled(): boolean;
+    userClass: _angular_core.InputSignal<ClassValue>;
+    labelClass: _angular_core.InputSignal<string>;
+    controlClass: _angular_core.InputSignal<string>;
+    inputClass: _angular_core.InputSignal<string>;
+    errorClass: _angular_core.InputSignal<string>;
+    hintClass: _angular_core.InputSignal<string>;
+    $userClass: _angular_core.Signal<string>;
+    $labelClass: _angular_core.Signal<string>;
+    $controlClass: _angular_core.Signal<string>;
+    $inputClass: _angular_core.Signal<string>;
+    $errorClass: _angular_core.Signal<string>;
+    $hintClass: _angular_core.Signal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<EgFormAutocomplete, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<EgFormAutocomplete, "eg-form-autocomplete", never, { "label": { "alias": "label"; "required": false; "isSignal": true; }; "controlId": { "alias": "controlId"; "required": false; "isSignal": true; }; "controlName": { "alias": "controlName"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "hint": { "alias": "hint"; "required": false; "isSignal": true; }; "id": { "alias": "id"; "required": false; "isSignal": true; }; "placeholder": { "alias": "placeholder"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "required": { "alias": "required"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; "userClass": { "alias": "class"; "required": false; "isSignal": true; }; "labelClass": { "alias": "labelClass"; "required": false; "isSignal": true; }; "controlClass": { "alias": "controlClass"; "required": false; "isSignal": true; }; "inputClass": { "alias": "inputClass"; "required": false; "isSignal": true; }; "errorClass": { "alias": "errorClass"; "required": false; "isSignal": true; }; "hintClass": { "alias": "hintClass"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+interface EgFormAutocompleteConfig {
+    /**
+     * Global class defaults for `eg-form-autocomplete` styling slots.
+     * Each is merged under the matching per-instance `*Class` input
+     * (library base < global config < per-instance).
+     */
+    labelClass?: string;
+    controlClass?: string;
+    inputClass?: string;
+    errorClass?: string;
+    hintClass?: string;
+}
+declare function provideEgFormAutocompleteConfig(config: Partial<EgFormAutocompleteConfig>): ValueProvider;
+declare function injectEgFormAutocompleteConfig(): EgFormAutocompleteConfig;
+
+export { EgFormAutocomplete, injectEgFormAutocompleteConfig, provideEgFormAutocompleteConfig };
+export type { EgFormAutocompleteConfig };

package/form-checkbox/README.md

@@ -1,3 +1,323 @@
-# Form Checkbox Subpath
+# Form Checkbox (`@egose/shadcn-theme-ng/form-checkbox`)
 
-This project ships only as `@egose/shadcn-theme-ng/form-checkbox` or `@egose/shadcn-theme-ng-tw/form-checkbox`. See the [package README](../../README.md) for installation, compatibility, Tailwind variant, test, and release guidance. Do not publish this project directory independently.
+A ready-made reactive-form checkbox row: `hlm-checkbox` + label + required marker with automatic `hlm-error` / `hlm-hint` display, wrapped in `eg-form-field` error switching. Equivalent to shadcn/ui `Form` + `Checkbox` composition.
+
+The Angular implementation is a standalone `ControlValueAccessor`-compatible wrapper (not a brain
+primitive itself): it renders `HlmCheckbox` bound with `formControlName`, `HlmLabel`, `EgFormField`
+from `@egose/shadcn-theme-ng/form-field-simple`, and `HlmError` / `HlmHint` from
+`@egose/shadcn-theme-ng/form-field`. It must live inside a `FormGroupDirective` (a
+`[formGroup]` parent) and forwards `ControlContainer` to it. Ids are generated by
+`HlmFormIdGenerator` unless overridden.
+
+> **Ships as:** `@egose/shadcn-theme-ng/form-checkbox` and `@egose/shadcn-theme-ng-tw/form-checkbox`
+> (the `tw:`-prefixed Tailwind variant). Both expose the identical TypeScript surface; only the
+> emitted Tailwind class strings differ. See the [package README](../../README.md) for install
+> steps, peer dependencies, and Tailwind setup. Do not publish this project directory independently.
+
+## Installation
+
+```bash
+# Plain Tailwind (no prefix)
+npm install @egose/shadcn-theme-ng
+
+# tw:-prefixed Tailwind variant
+npm install @egose/shadcn-theme-ng-tw
+```
+
+Peer dependencies (Angular, `@spartan-ng/brain`, `@ng-icons/*`, `rxjs`, …) are documented in the
+[package README](../../README.md#peer-dependencies). This subpath additionally relies at runtime on
+`@egose/shadcn-theme-ng/checkbox`, `@egose/shadcn-theme-ng/label`,
+`@egose/shadcn-theme-ng/form-field`, and `@egose/shadcn-theme-ng/form-field-simple`.
+
+## Imports
+
+Exported from the subpath root (`projects/form-checkbox/src/public-api.ts`). Note: this subpath
+exports a single standalone component — there is no `*Imports` array or `*Module`:
+
+```ts
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+// tw variant: replace with '@egose/shadcn-theme-ng-tw/form-checkbox'
+```
+
+Standalone usage:
+
+```ts
+import { Component } from '@angular/core';
+import { ReactiveFormsModule } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-demo',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `...`,
+})
+export class DemoComponent {}
+```
+
+NgModule-based consumer: add `EgFormCheckbox` (and `ReactiveFormsModule`) to the module's `imports`
+— it is a standalone component, not a module.
+
+`ControlValueAccessor` behavior: `eg-form-checkbox` itself is not a `ControlValueAccessor`; the
+inner `hlm-checkbox` is bound via `[formControlName]="controlName()"`, so the parent `FormGroup`
+owns the value. `checked()` sets the initial checkbox input; the form control is the source of
+truth afterwards.
+
+## Anatomy / Structure
+
+```html
+<form [formGroup]="form">
+  <eg-form-checkbox
+    controlName="acceptTerms"
+    label="Accept terms and conditions"
+    [required]="true"
+    hint="You must accept to continue."
+    error="You must accept the terms."
+  />
+</form>
+```
+
+Selector (from source): `eg-form-checkbox` (standalone component).
+
+## API reference
+
+### `EgFormCheckbox` — `eg-form-checkbox`
+
+| Input           | Type                  | Default | Description                                                                                 |
+| --------------- | --------------------- | ------- | ------------------------------------------------------------------------------------------- |
+| `controlName`   | `string`              | `''`    | `formControlName` key inside the parent `FormGroup`. **Required.**                          |
+| `label`         | `string`              | `''`    | Label text next to the checkbox.                                                            |
+| `error`         | `string \| undefined` | —       | Error text shown when the control is invalid + touched/dirty (via `EgFormField` switching). |
+| `hint`          | `string \| undefined` | —       | Hint text shown when there is no error to display.                                          |
+| `controlId`     | `string \| undefined` | —       | Explicit control id (first priority for `effectiveId`).                                     |
+| `id`            | `string \| undefined` | —       | Fallback id (second priority).                                                              |
+| `name`          | `string \| undefined` | —       | Checkbox `name` attribute (defaults to `controlName`).                                      |
+| `checked`       | `boolean`             | `false` | Initial checked state passed to `hlm-checkbox`.                                             |
+| `required`      | `boolean`             | `false` | Shows a red `*` and sets checkbox `required`.                                               |
+| `disabled`      | `boolean`             | `false` | Locks interaction via checkbox `wrapperDisabled` (does not write to the form control).      |
+| `class`         | `ClassValue`          | `''`    | Extra host classes.                                                                         |
+| `checkboxClass` | `string`              | `''`    | Extra classes for `hlm-checkbox`.                                                           |
+| `labelClass`    | `string`              | `''`    | Extra classes for the label.                                                                |
+| `errorClass`    | `string`              | `''`    | Extra classes for `hlm-error`.                                                              |
+| `hintClass`     | `string`              | `''`    | Extra classes for `hlm-hint`.                                                               |
+
+| Member               | Description                                                                                                                          |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| `effectiveId`        | `controlId() \|\| id() \|\| generated` — wired to checkbox `id` and label `for`.                                                     |
+| `errorId` / `hintId` | `effectiveId + '-error' / '-hint'` for `aria-describedby`.                                                                           |
+| `describedBy()`      | Returns `errorId` when `error()` is set and the control is invalid + dirty/touched, else `hintId` when `hint()` is set, else `null`. |
+
+Requires a `[formGroup]` ancestor: the component injects `FormGroupDirective` and provides
+`ControlContainer → FormGroupDirective` so `formControlName` resolves.
+
+## Examples
+
+### 1. Basic required terms checkbox
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule, Validators } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-terms',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form" (ngSubmit)="submit()">
+      <eg-form-checkbox
+        controlName="accept"
+        label="Accept terms and conditions"
+        [required]="true"
+        error="You must accept the terms."
+      />
+      <button type="submit" [disabled]="form.invalid">Continue</button>
+    </form>
+  `,
+})
+export class TermsComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ accept: [false, Validators.requiredTrue] });
+  submit() {
+    console.log(this.form.value);
+  }
+}
+```
+
+### 2. Hint + validation error display
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule, Validators } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-newsletter',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form">
+      <eg-form-checkbox
+        controlName="newsletter"
+        label="Email me news and offers"
+        hint="One email per month, unsubscribe anytime."
+        error="Please confirm your preference."
+      />
+    </form>
+    <p class="tw:text-sm">Value: {{ form.value.newsletter }}</p>
+  `,
+})
+export class NewsletterComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ newsletter: [true, Validators.requiredTrue] });
+}
+```
+
+### 3. Disabled / locked checkbox
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-locked',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form">
+      <eg-form-checkbox
+        controlName="readonly"
+        label="Two-factor authentication (enforced)"
+        [checked]="true"
+        [disabled]="true"
+        hint="Managed by your organization."
+      />
+    </form>
+  `,
+})
+export class LockedComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ readonly: [true] });
+}
+```
+
+> `disabled` locks the UI via `wrapperDisabled` without disabling the form control itself, so the
+> value still submits. To exclude the value, call `form.get('readonly')?.disable()` instead.
+
+### 4. Custom ids + styling hooks
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-styled-check',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form">
+      <eg-form-checkbox
+        controlName="marketing"
+        controlId="marketing-opt-in"
+        label="Send me product updates"
+        checkboxClass="tw:border-primary"
+        labelClass="tw:font-medium"
+        class="tw:rounded-md tw:border tw:p-3"
+      />
+    </form>
+  `,
+})
+export class StyledCheckComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ marketing: [false] });
+}
+```
+
+### 5. Settings list (multiple checkboxes, one group)
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-settings',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form" class="tw:grid tw:gap-3">
+      <eg-form-checkbox controlName="email" label="Email notifications" />
+      <eg-form-checkbox controlName="sms" label="SMS notifications" hint="Carrier rates may apply." />
+      <eg-form-checkbox controlName="push" label="Push notifications" />
+    </form>
+    <pre class="tw:text-xs">{{ form.value | json }}</pre>
+  `,
+})
+export class SettingsComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ email: [true], sms: [false], push: [true] });
+}
+```
+
+### 6. Submitted-state validation (mark all touched)
+
+```ts
+import { Component, inject } from '@angular/core';
+import { FormBuilder, ReactiveFormsModule, Validators } from '@angular/forms';
+import { EgFormCheckbox } from '@egose/shadcn-theme-ng/form-checkbox';
+
+@Component({
+  selector: 'app-submit-check',
+  standalone: true,
+  imports: [ReactiveFormsModule, EgFormCheckbox],
+  template: `
+    <form [formGroup]="form" (ngSubmit)="submit()">
+      <eg-form-checkbox
+        controlName="consent"
+        label="I consent to data processing"
+        [required]="true"
+        error="Consent is required to create your account."
+      />
+      <button type="submit">Create account</button>
+    </form>
+  `,
+})
+export class SubmitCheckComponent {
+  private readonly fb = inject(FormBuilder);
+  readonly form = this.fb.group({ consent: [false, Validators.requiredTrue] });
+  submit() {
+    this.form.markAllAsTouched();
+    if (this.form.valid) console.log('creating account…');
+  }
+}
+```
+
+## Accessibility notes
+
+- The checkbox `id` and label `for` are generated (`eg-form-checkbox-<app>-<n>`) unless `controlId`/`id` is given — labels are always programmatically associated.
+- `aria-describedby` points at the error id only while the control is invalid + touched/dirty, otherwise at the hint id — screen readers hear the right message in each state.
+- The required marker (`*`) is visual; the underlying `hlm-checkbox` also receives `required` so assistive tech announces it.
+- Keep the component inside a `<form>` with a submit path; the row itself is a single tab stop (the checkbox).
+
+## Theming / CSS variables
+
+No component-specific CSS variables. Style per-instance via `class`, `checkboxClass`, `labelClass`, `errorClass`, `hintClass` inputs. The row layout (`flex items-center gap-1`) is fixed in the template.
+
+Global defaults per styling slot via the wrapper config (precedence: library base < global config < per-instance):
+
+```ts
+import { provideEgFormCheckboxConfig } from '@egose/shadcn-theme-ng/form-checkbox';
+
+await bootstrapApplication(App, {
+  providers: [provideEgFormCheckboxConfig({ checkboxClass: 'tw:size-5', labelClass: 'tw:font-medium' })],
+});
+```
+
+## Related subpaths
+
+- `@egose/shadcn-theme-ng/checkbox` — standalone `hlm-checkbox` when you need a custom layout.
+- `@egose/shadcn-theme-ng/form-field-simple` — `eg-form-field` error/hint switching used internally.
+- `@egose/shadcn-theme-ng/form-field` — `hlm-form-field` / `hlm-error` / `hlm-hint` primitives.
+- `@egose/shadcn-theme-ng/label` — `HlmLabel` used for the row label.