forty-cdk 0.2.0 → 0.3.0

package/types/forty-cdk-switch.d.ts

@@ -0,0 +1,87 @@
+import * as i0 from '@angular/core';
+import { Provider } from '@angular/core';
+import { FormCheckboxControl } from '@angular/forms/signals';
+import { FormUiControlBase } from 'forty-cdk/core';
+
+/**
+ * Headless on/off switch implementing the
+ * [WAI-ARIA Switch pattern](https://www.w3.org/WAI/ARIA/apg/patterns/switch/)
+ * and Angular's `FormCheckboxControl` from `@angular/forms/signals` so it
+ * auto-wires with `[formField]`.
+ *
+ * Apply on a `<button type="button">` so Enter / Space activation come from
+ * native button behavior. The directive forces `type="button"` to prevent
+ * accidental form submission when nested inside a `<form>`.
+ *
+ * @example
+ * ```html
+ * <button forSwitch [(checked)]="enabled">
+ *   <span class="thumb"></span>
+ * </button>
+ *
+ * <!-- With Signal Forms: -->
+ * <button forSwitch [formField]="settings.notifications"></button>
+ * ```
+ */
+declare class ForSwitch extends FormUiControlBase implements FormCheckboxControl {
+    /** Two-way bindable on/off state. Required by `FormCheckboxControl`. */
+    readonly checked: i0.ModelSignal<boolean>;
+    constructor();
+    protected onClick(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ForSwitch, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ForSwitch, "[forSwitch]", ["forSwitch"], { "checked": { "alias": "checked"; "required": false; "isSignal": true; }; }, { "checked": "checkedChange"; }, never, never, true, never>;
+}
+
+/**
+ * Defaults inherited by descendant switches in the surrounding injector
+ * scope. Configure with `provideForSwitchDefaults`. The shape is a stub
+ * today — present so future per-scope tuning can land without churning the
+ * public surface.
+ */
+interface ForSwitchDefaults {
+}
+/** Token holding the resolved switch defaults for the current scope. */
+declare const FOR_SWITCH_DEFAULTS: i0.InjectionToken<ForSwitchDefaults>;
+/**
+ * Configures forty-cdk switch defaults for this injector scope. Partial
+ * overrides inherit unspecified keys from the parent scope (or library
+ * defaults at the root).
+ */
+declare function provideForSwitchDefaults(defaults?: Partial<ForSwitchDefaults>): Provider[];
+
+/**
+ * Exact public names of every `ForSwitch` input, its models included. Spread it into the
+ * `inputs` array of a `hostDirectives` entry so a wrapper component re-exposes the
+ * primitive's full surface — the Signal Forms members `[formField]` binds among them —
+ * without hand-maintaining the list. Always spread into an inline object literal as shown
+ * below: the literal is what keeps the entry statically analyzable for consumers compiling
+ * against the published package. An anti-drift spec fails when this list no longer matches
+ * the directive's actual API. See `docs/wrapping-form-primitives.md` for both supported
+ * wrapping patterns.
+ *
+ * @example
+ * ```ts
+ * @Component({
+ *   selector: 'button[mySwitch]',
+ *   template: '',
+ *   hostDirectives: [
+ *     {
+ *       directive: ForSwitch,
+ *       inputs: [...FOR_SWITCH_HOST_DIRECTIVE_INPUTS],
+ *       outputs: [...FOR_SWITCH_HOST_DIRECTIVE_OUTPUTS],
+ *     },
+ *   ],
+ * })
+ * export class MySwitch {}
+ * ```
+ */
+declare const FOR_SWITCH_HOST_DIRECTIVE_INPUTS: readonly ["checked", "dirty", "disabled", "errors", "invalid", "name", "pending", "readonly", "required", "touched"];
+/**
+ * Exact public names of every `ForSwitch` output, the Signal Forms `touch` output
+ * included. Spread it into the `outputs` array of the same `hostDirectives` entry as
+ * {@link FOR_SWITCH_HOST_DIRECTIVE_INPUTS}.
+ */
+declare const FOR_SWITCH_HOST_DIRECTIVE_OUTPUTS: readonly ["checkedChange", "touchedChange", "touch"];
+
+export { FOR_SWITCH_DEFAULTS, FOR_SWITCH_HOST_DIRECTIVE_INPUTS, FOR_SWITCH_HOST_DIRECTIVE_OUTPUTS, ForSwitch, provideForSwitchDefaults };
+export type { ForSwitchDefaults };