forty-cdk 0.2.0 → 0.3.0

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

@@ -0,0 +1,80 @@
+import * as _angular_core from '@angular/core';
+import { Provider } from '@angular/core';
+
+/**
+ * Headless implementation of the [WAI-ARIA Button pattern](https://www.w3.org/WAI/ARIA/apg/patterns/button/).
+ *
+ * Works on a native `<button>` host and on any arbitrary host element (e.g. `<div>`, `<span>`).
+ * On a native button the platform handles Enter/Space → click synthesis and no `role` or
+ * `tabindex` is emitted (the platform owns those). On a non-button host, `role="button"` and
+ * `tabindex="0"` are applied, and keydown for Enter/Space synthesizes a click so the directive's
+ * single `onClick` path handles all activations.
+ *
+ * Disabled stays focusable: per the APG a disabled button must remain reachable by assistive
+ * technology, so the native `disabled` attribute is never set. Instead `aria-disabled="true"` and
+ * `data-disabled=""` are reflected and the activation handler becomes a no-op.
+ *
+ * Interaction state is reflected as `data-pressed`, `data-hovered`, and `data-focus-visible`
+ * (present/absent boolean attributes). There is no `data-state` — this primitive has no
+ * open/closed or checked/unchecked logical state.
+ *
+ * @example
+ * ```html
+ * <!-- Native button — platform handles Enter/Space -->
+ * <button forButton (activate)="doSomething()">Click me</button>
+ *
+ * <!-- Non-button host — role, tabindex, and keyboard handling added automatically -->
+ * <div forButton (activate)="doSomething()">Click me</div>
+ *
+ * <!-- Disabled: stays focusable, activation is a no-op -->
+ * <button forButton [disabled]="true" (activate)="doSomething()">Disabled</button>
+ * ```
+ */
+declare class ForButton {
+    #private;
+    /**
+     * When `true`, activation (click, Enter, Space) is suppressed and the element
+     * reflects `aria-disabled="true"` + `data-disabled=""`. The element remains
+     * focusable so assistive technology can announce it.
+     */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Emitted once per user activation: a pointer click on any host, or Enter / Space
+     * on a non-native-button host (native buttons synthesize click from keyboard). The
+     * name `activate` is chosen deliberately to avoid colliding with the native `click`
+     * event (which would trip `@angular-eslint/no-output-native` on wrapping consumers).
+     */
+    readonly activate: _angular_core.OutputEmitterRef<void>;
+    protected readonly hovered: _angular_core.Signal<boolean>;
+    protected readonly pressed: _angular_core.Signal<boolean>;
+    protected readonly focusVisible: _angular_core.Signal<boolean>;
+    protected readonly resolvedType: _angular_core.Signal<string | null>;
+    protected readonly resolvedRole: _angular_core.Signal<"button" | null>;
+    protected readonly resolvedTabindex: _angular_core.Signal<"0" | null>;
+    protected onClick(event: MouseEvent): void;
+    protected onKeydown(event: KeyboardEvent): void;
+    protected onFocusIn(): void;
+    protected onFocusOut(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ForButton, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<ForButton, "[forButton]", ["forButton"], { "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, { "activate": "activate"; }, never, never, true, never>;
+}
+
+/**
+ * Defaults inherited by descendant buttons in the surrounding injector
+ * scope. Configure with `provideForButtonDefaults`. The shape is a stub
+ * today — present so future per-scope tuning can land without churning the
+ * public surface.
+ */
+interface ForButtonDefaults {
+}
+/** Token holding the resolved button defaults for the current scope. */
+declare const FOR_BUTTON_DEFAULTS: _angular_core.InjectionToken<ForButtonDefaults>;
+/**
+ * Configures forty-cdk button defaults for this injector scope. Partial
+ * overrides inherit unspecified keys from the parent scope (or library
+ * defaults at the root).
+ */
+declare function provideForButtonDefaults(defaults?: Partial<ForButtonDefaults>): Provider[];
+
+export { FOR_BUTTON_DEFAULTS, ForButton, provideForButtonDefaults };
+export type { ForButtonDefaults };