ngwr 6.1.1 → 7.0.0

package/types/ngwr-result.d.ts

@@ -0,0 +1,64 @@
+import * as _angular_core from '@angular/core';
+
+/** Built-in status — picks the default icon + accent colour. */
+type WrResultStatus = 'success' | 'warning' | 'error' | 'info' | 'empty';
+
+/**
+ * Large-illustration result / empty-state. Use after a successful action,
+ * for empty list states, or 404 / 500 pages.
+ *
+ * @example
+ * ```html
+ * <wr-result status="success" title="Submitted!" description="We'll be in touch.">
+ *   <button wrButton color="primary" wrResultExtra>Continue</button>
+ * </wr-result>
+ *
+ * <wr-result status="empty" title="No projects yet">
+ *   <button wrButton wrResultExtra>Create one</button>
+ * </wr-result>
+ * ```
+ *
+ * @see https://ngwr.dev/components/result
+ */
+declare class WrResult {
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string>;
+    readonly status: _angular_core.InputSignal<WrResultStatus>;
+    protected readonly classes: _angular_core.Signal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrResult, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrResult, "wr-result", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; "status": { "alias": "status"; "required": false; "isSignal": true; }; }, {}, never, ["[wrResultExtra]"], true, never>;
+}
+
+/**
+ * Pre-set 404 result. Override `title` / `description` for localisation.
+ *
+ * @example
+ * ```html
+ * <wr-result-404>
+ *   <button wrButton wrResultExtra>Back home</button>
+ * </wr-result-404>
+ * ```
+ */
+declare class WrResult404 {
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrResult404, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrResult404, "wr-result-404", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+/** Pre-set 403 result — forbidden / no access. */
+declare class WrResult403 {
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrResult403, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrResult403, "wr-result-403", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+/** Pre-set 500 result — internal server error. */
+declare class WrResult500 {
+    readonly title: _angular_core.InputSignal<string>;
+    readonly description: _angular_core.InputSignal<string>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrResult500, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrResult500, "wr-result-500", never, { "title": { "alias": "title"; "required": false; "isSignal": true; }; "description": { "alias": "description"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+
+export { WrResult, WrResult403, WrResult404, WrResult500 };
+export type { WrResultStatus };

package/types/ngwr-rotating-text.d.ts

@@ -0,0 +1,72 @@
+import * as _angular_core from '@angular/core';
+
+type WrRotatingTextSplit = 'characters' | 'words' | 'lines';
+type WrRotatingTextStaggerFrom = 'first' | 'last' | 'center';
+
+interface Word {
+    readonly characters: readonly string[];
+    readonly needsSpace: boolean;
+}
+/**
+ * Cycles through a list of strings, animating each transition
+ * character-by-character (or word/line). Auto-advances on a timer by
+ * default; can also be controlled imperatively via `next()` /
+ * `previous()` / `jumpTo()` / `reset()`.
+ *
+ * @example
+ * ```html
+ * <wr-rotating-text [texts]="['design', 'ship', 'iterate']" />
+ *
+ * // Manual control:
+ * @ViewChild(WrRotatingText) rotator!: WrRotatingText;
+ * onClick(): void { this.rotator.next(); }
+ * ```
+ *
+ * @see https://www.reactbits.dev/text-animations/rotating-text
+ */
+declare class WrRotatingText {
+    /** Strings to cycle. Required. */
+    readonly texts: _angular_core.InputSignal<readonly string[]>;
+    /** Auto-advance interval in ms. @default 2000 */
+    readonly rotationInterval: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Granularity of the split. @default 'characters' */
+    readonly splitBy: _angular_core.InputSignal<WrRotatingTextSplit>;
+    /** Auto-advance on a timer. @default true */
+    readonly auto: _angular_core.InputSignalWithTransform<boolean, any>;
+    /** Loop back to the first string after the last. @default true */
+    readonly loop: _angular_core.InputSignalWithTransform<boolean, any>;
+    /** Per-swap tween duration in seconds. @default 0.6 */
+    readonly duration: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** CSS easing of the per-piece tween. @default 'cubic-bezier(0.16, 1, 0.3, 1)' (~power3.out) */
+    readonly easing: _angular_core.InputSignal<string>;
+    /** Per-piece stagger in seconds. @default 0 */
+    readonly staggerDuration: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Stagger origin. @default 'first' */
+    readonly staggerFrom: _angular_core.InputSignal<WrRotatingTextStaggerFrom>;
+    /** Emitted with the new index on every rotation. */
+    readonly nextChange: _angular_core.OutputEmitterRef<number>;
+    protected readonly index: _angular_core.WritableSignal<number>;
+    protected readonly current: _angular_core.Signal<string>;
+    protected readonly words: _angular_core.Signal<readonly Word[]>;
+    private readonly host;
+    private readonly destroyRef;
+    private readonly isBrowser;
+    private readonly platform;
+    private timerId;
+    private isAnimating;
+    constructor();
+    next(): void;
+    previous(): void;
+    jumpTo(target: number): void;
+    reset(): void;
+    private restartTimer;
+    private transitionTo;
+    private animateIn;
+    private animateOut;
+    private delayFor;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrRotatingText, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrRotatingText, "wr-rotating-text", never, { "texts": { "alias": "texts"; "required": true; "isSignal": true; }; "rotationInterval": { "alias": "rotationInterval"; "required": false; "isSignal": true; }; "splitBy": { "alias": "splitBy"; "required": false; "isSignal": true; }; "auto": { "alias": "auto"; "required": false; "isSignal": true; }; "loop": { "alias": "loop"; "required": false; "isSignal": true; }; "duration": { "alias": "duration"; "required": false; "isSignal": true; }; "easing": { "alias": "easing"; "required": false; "isSignal": true; }; "staggerDuration": { "alias": "staggerDuration"; "required": false; "isSignal": true; }; "staggerFrom": { "alias": "staggerFrom"; "required": false; "isSignal": true; }; }, { "nextChange": "nextChange"; }, never, never, true, never>;
+}
+
+export { WrRotatingText };
+export type { WrRotatingTextSplit, WrRotatingTextStaggerFrom };

package/types/ngwr-scramble-text.d.ts

@@ -0,0 +1,49 @@
+import * as _angular_core from '@angular/core';
+
+/**
+ * Cursor-proximity scrambler. Each character inside the projected text
+ * scrambles through `scrambleChars` whenever the pointer moves within
+ * `radius` px of it, then settles back to the original. Closer pointer →
+ * longer scramble.
+ *
+ * @example
+ * ```html
+ * <wr-scramble-text
+ *   [radius]="120"
+ *   [duration]="1.4"
+ *   scrambleChars="!&%*"
+ * >
+ *   Hover this paragraph to scramble characters near the cursor.
+ * </wr-scramble-text>
+ * ```
+ *
+ * @see https://www.reactbits.dev/text-animations/scrambled-text
+ */
+declare class WrScrambleText {
+    /** Proximity radius in pixels. @default 100 */
+    readonly radius: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Max scramble duration in seconds (scaled by proximity — closer = longer). @default 1.2 */
+    readonly duration: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Approximate seconds between random-char swaps. Lower = faster scramble. @default 0.05 */
+    readonly speed: _angular_core.InputSignalWithTransform<number, unknown>;
+    /** Pool of glyphs to scramble through. @default '.:' */
+    readonly scrambleChars: _angular_core.InputSignal<string>;
+    private readonly host;
+    private readonly destroyRef;
+    private readonly isBrowser;
+    private readonly platform;
+    /** One entry per active scramble, keyed by char span. */
+    private readonly active;
+    /** Cached list of char spans. Re-computed after each render. */
+    private chars;
+    constructor();
+    protected onPointerMove(event: PointerEvent): void;
+    /** Walk the projected text and wrap each non-whitespace character in a span. */
+    private split;
+    private cancelOne;
+    private clearAll;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrScrambleText, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrScrambleText, "wr-scramble-text", never, { "radius": { "alias": "radius"; "required": false; "isSignal": true; }; "duration": { "alias": "duration"; "required": false; "isSignal": true; }; "speed": { "alias": "speed"; "required": false; "isSignal": true; }; "scrambleChars": { "alias": "scrambleChars"; "required": false; "isSignal": true; }; }, {}, never, ["*"], true, never>;
+}
+
+export { WrScrambleText };

package/types/ngwr-scroll.d.ts

@@ -0,0 +1,65 @@
+import * as i0 from '@angular/core';
+
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+/**
+ * What to scroll to — an `Element`, an `id` string (looked up via
+ * `getElementById`), an arbitrary CSS selector, or absolute coordinates.
+ */
+type WrScrollTarget = Element | string | {
+    top: number;
+    left?: number;
+};
+/** Options accepted by {@link WrScroll} scroll methods. */
+interface WrScrollOptions {
+    /** Pixel offset to subtract from the target — handy for sticky headers. @default 0 */
+    readonly offset?: number;
+    /** Smooth or instant scrolling. @default true (smooth) */
+    readonly smooth?: boolean;
+    /**
+     * Scroll container. `window` (default) means the document; pass an
+     * `Element` to scroll a nested overflow container instead.
+     */
+    readonly container?: Window | Element;
+}
+
+/**
+ * Smooth-scroll utility. Resolves `id` / selector / element / coords
+ * targets; subtracts an `offset` (for sticky headers); respects
+ * `prefers-reduced-motion` — automatically falls back to instant
+ * scrolling when the user has opted out.
+ *
+ * SSR-safe — all methods no-op on the server.
+ *
+ * @example
+ * ```ts
+ * const scroll = inject(WrScroll);
+ * scroll.to('#section-three', { offset: 80 });
+ * scroll.toTop({ smooth: false });
+ * scroll.intoView(myEl, { offset: 64 });
+ * ```
+ *
+ * @see https://ngwr.dev/services/scroll
+ */
+declare class WrScroll {
+    private readonly doc;
+    private readonly platform;
+    /** Scroll to an arbitrary target. */
+    to(target: WrScrollTarget, options?: WrScrollOptions): void;
+    /** Convenience for an element — accepts the same options. */
+    intoView(el: Element, options?: WrScrollOptions): void;
+    /** Scroll the page (or container) to the top. */
+    toTop(options?: WrScrollOptions): void;
+    private resolveSelector;
+    private behavior;
+    private scroll;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WrScroll, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WrScroll>;
+}
+
+export { WrScroll };
+export type { WrScrollOptions, WrScrollTarget };

package/types/ngwr-segmented.d.ts

@@ -0,0 +1,65 @@
+import * as _angular_core from '@angular/core';
+import { WrIconName } from 'ngwr/icon';
+
+/**
+ * @license
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
+ */
+
+/**
+ * One entry in a `<wr-segmented>` track.
+ *
+ * `value` is what the model receives when this segment is picked.
+ * `label` is shown when present; otherwise an icon-only segment renders.
+ */
+interface WrSegmentedOption<T = unknown> {
+    readonly value: T;
+    readonly label?: string;
+    readonly icon?: WrIconName;
+    readonly disabled?: boolean;
+}
+
+/**
+ * Single-choice picker rendered as a segmented control. Two-way binds
+ * the selected `value`.
+ *
+ * @example
+ * ```html
+ * <wr-segmented
+ *   [options]="[
+ *     { value: 'day',  label: 'Day' },
+ *     { value: 'week', label: 'Week' },
+ *     { value: 'month', label: 'Month' },
+ *   ]"
+ *   [(value)]="range"
+ * />
+ * ```
+ *
+ * @see https://ngwr.dev/components/segmented
+ */
+declare class WrSegmented<T = unknown> {
+    /** The segments to render. */
+    readonly options: _angular_core.InputSignal<readonly WrSegmentedOption<T>[]>;
+    /** Two-way bindable selected value. */
+    readonly value: _angular_core.ModelSignal<T | null>;
+    /** Disable the whole control. @default false */
+    readonly disabled: _angular_core.InputSignalWithTransform<boolean, any>;
+    /** Index of the selected option, or `-1` when nothing is selected. */
+    protected readonly selectedIndex: _angular_core.Signal<number>;
+    /** Flips true after the first paint so the thumb only animates user-driven changes, not the initial snap. */
+    private readonly mounted;
+    constructor();
+    protected readonly classes: _angular_core.Signal<string>;
+    /** Inline CSS vars driving the sliding thumb position. */
+    protected readonly thumbStyle: _angular_core.Signal<Record<string, string>>;
+    protected isSelected(option: WrSegmentedOption<T>): boolean;
+    protected select(option: WrSegmentedOption<T>): void;
+    protected trackByValue(_: number, option: WrSegmentedOption<T>): unknown;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<WrSegmented<any>, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<WrSegmented<any>, "wr-segmented", never, { "options": { "alias": "options"; "required": true; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; }, never, never, true, never>;
+}
+
+export { WrSegmented };
+export type { WrSegmentedOption };