@nanahoshi/mona-ui 0.13.1 → 0.15.0

package/types/nanahoshi-mona-ui-spinner.d.ts

@@ -0,0 +1,114 @@
+import * as _angular_core from '@angular/core';
+import { ElementRef, OnDestroy } from '@angular/core';
+import { LucideLoader } from '@lucide/angular';
+import { ClassInputType } from '@nanahoshi/mona-ui/common';
+import * as class_variance_authority_types from 'class-variance-authority/types';
+import { VariantProps } from 'class-variance-authority';
+import { VariantInputs } from '@nanahoshi/mona-ui/internal';
+import { Observable } from 'rxjs';
+
+type SpinnerAppearance = "default" | "pulsing" | "pulsing-triad" | "pulsing-ring" | "converging-spinner";
+
+type SpinnerSize = "small" | "medium" | "large";
+
+declare const spinnerThemeVariants: (props?: ({
+    size?: "small" | "medium" | "large" | null | undefined;
+} & class_variance_authority_types.ClassProp) | undefined) => string;
+type SpinnerVariantProps = VariantProps<typeof spinnerThemeVariants>;
+type SpinnerVariantInput = VariantInputs<SpinnerVariantProps>;
+
+/**
+ * @description
+ * An indeterminate loading indicator primitive for communicating ongoing activity.
+ * Supports multiple appearances, standard sizes, and accessible status announcements.
+ */
+declare class SpinnerComponent implements SpinnerVariantInput {
+    protected readonly baseClass: _angular_core.Signal<string>;
+    protected readonly loaderIcon: typeof LucideLoader;
+    protected readonly pixelSize: _angular_core.Signal<12 | 24 | 16>;
+    /**
+     * @description Visual appearance of the spinner animation.
+     * @default "default"
+     */
+    readonly appearance: _angular_core.InputSignal<SpinnerAppearance>;
+    /**
+     * @description Accessible text announced by assistive technology when the spinner is not decorative.
+     * @default "Loading"
+     */
+    readonly ariaLabel: _angular_core.InputSignal<string>;
+    /**
+     * @description When `true`, removes the `status` role and hides the spinner from assistive technology with `aria-hidden="true"`.
+     * Useful when a parent element already manages loading semantics (such as `aria-busy="true"` on a button).
+     * @default false
+     */
+    readonly decorative: _angular_core.InputSignal<boolean>;
+    /**
+     * @description Size preset controlling the dimensions of the indicator.
+     * @default "medium"
+     */
+    readonly size: _angular_core.InputSignal<SpinnerSize>;
+    /**
+     * @description Additional CSS classes merged onto the host element via `tailwind-merge`.
+     * @default ""
+     */
+    readonly userClass: _angular_core.InputSignalWithTransform<string, ClassInputType>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SpinnerComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<SpinnerComponent, "mona-spinner", never, { "appearance": { "alias": "appearance"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "aria-label"; "required": false; "isSignal": true; }; "decorative": { "alias": "decorative"; "required": false; "isSignal": true; }; "size": { "alias": "size"; "required": false; "isSignal": true; }; "userClass": { "alias": "class"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+interface SpinnerCancelOptions {
+    onCancel?: () => void;
+    text?: string;
+}
+interface SpinnerOptions {
+    appearance?: SpinnerAppearance;
+    cancellable?: boolean | SpinnerCancelOptions;
+    delay?: number;
+    id?: string;
+    minimumVisibleDuration?: number;
+    size?: SpinnerSize;
+    target?: HTMLElement | ElementRef<HTMLElement> | readonly (HTMLElement | ElementRef<HTMLElement>)[];
+    text?: string;
+    zIndex?: number;
+}
+
+interface SpinnerUpdate {
+    appearance?: SpinnerAppearance;
+    size?: SpinnerSize;
+    text?: string;
+}
+
+interface SpinnerRef {
+    readonly cancelled$: Observable<void>;
+    readonly id: string;
+    close(): void;
+    update(update: SpinnerUpdate): void;
+}
+
+declare class SpinnerService implements OnDestroy {
+    #private;
+    /**
+     * Hides and destroys the spinner associated with the given `SpinnerRef` or string `id`.
+     */
+    hide(refOrId: SpinnerRef | string): void;
+    /**
+     * Tears down every active/pending spinner request and physical overlay so
+     * nothing is left behind if the service outlives its consumers.
+     */
+    ngOnDestroy(): void;
+    /**
+     * Displays a spinner loading overlay according to the provided options.
+     * Returns a `SpinnerRef` handle for lifecycle management and updates.
+     */
+    show(options?: SpinnerOptions): SpinnerRef;
+    /**
+     * Wraps an Observable operation with a Spinner lifecycle.
+     * Shows the spinner on subscription and closes it when the observable completes, errors, or is unsubscribed.
+     */
+    track<T>(source: Observable<T>, options?: SpinnerOptions): Observable<T>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<SpinnerService, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<SpinnerService>;
+}
+
+export { SpinnerComponent, SpinnerService };
+export type { SpinnerAppearance, SpinnerCancelOptions, SpinnerOptions, SpinnerRef, SpinnerSize, SpinnerUpdate, SpinnerVariantProps };