@tekus/design-system 5.34.0 → 5.35.0

package/types/tekus-design-system-components-process-steps.d.ts

@@ -0,0 +1,57 @@
+import * as _angular_core from '@angular/core';
+
+type StepState = 'waiting' | 'active' | 'done' | 'error' | 'warning';
+interface ProcessStep {
+    label: string;
+    state: StepState;
+}
+/**
+ * Overall result of the process:
+ * - `progress`: shows the spinner header and the step list.
+ * - `success` | `error` | `warning`: replaces the progress view with a
+ *   final result message (used once polling finishes).
+ */
+type ProcessStepsStatus = 'progress' | 'success' | 'error' | 'warning';
+
+declare class ProcessStepsComponent {
+    readonly steps: _angular_core.InputSignal<ProcessStep[]>;
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string | undefined>;
+    readonly icon: _angular_core.InputSignal<string>;
+    readonly status: _angular_core.InputSignal<ProcessStepsStatus>;
+    /** Specific problems to list inside the result message box (ignored when `status` is `success`). */
+    readonly errors: _angular_core.InputSignal<string[]>;
+    /** Seconds until the countdown finishes; omit to disable it. */
+    readonly countdownSeconds: _angular_core.InputSignal<number | undefined>;
+    /**
+     * Countdown text; `{seconds}` is replaced with the seconds left. Defaults to a "closing"
+     * message, but the countdown isn't only for closing — override it to match what
+     * `(countdownFinished)` actually does.
+     */
+    readonly countdownLabel: _angular_core.InputSignal<string>;
+    /** Emitted once when the countdown reaches zero — the consumer decides what happens next (close a modal, show a toast, etc.). */
+    readonly countdownFinished: _angular_core.OutputEmitterRef<void>;
+    /** Seconds left in the countdown, or `undefined` while it's disabled. */
+    readonly remainingSeconds: _angular_core.WritableSignal<number | undefined>;
+    constructor();
+    /** Starts (or disables) the countdown whenever `status`/`countdownSeconds` change. */
+    private runCountdown;
+    /** Decrements `remainingSeconds` by one and emits `countdownFinished` once it bottoms out. */
+    private tickCountdown;
+    /**
+     * Accessible suffix announced per step since state is otherwise
+     * conveyed only through color/icon.
+     */
+    stepStatusLabel(state: StepState): string;
+    readonly resultIcon: _angular_core.Signal<string>;
+    readonly resultColor: _angular_core.Signal<"warning" | "success" | "danger">;
+    /** Severity for the message box wrapping `description`/`errors` (success has no box). */
+    readonly resultMessageSeverity: _angular_core.Signal<"error" | "warn">;
+    /** `countdownLabel` with `{seconds}` filled in, or `undefined` while the countdown is disabled. */
+    readonly countdownText: _angular_core.Signal<string | undefined>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ProcessStepsComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ProcessStepsComponent, "tk-process-steps", never, { "steps": { "alias": "steps"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": true; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; "icon": { "alias": "icon"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; "errors": { "alias": "errors"; "required": false; "isSignal": true; }; "countdownSeconds": { "alias": "countdownSeconds"; "required": false; "isSignal": true; }; "countdownLabel": { "alias": "countdownLabel"; "required": false; "isSignal": true; }; }, { "countdownFinished": "countdownFinished"; }, never, never, true, never>;
+}
+
+export { ProcessStepsComponent };
+export type { ProcessStep, ProcessStepsStatus, StepState };