ng-primitives 0.89.0 → 0.91.0

package/input-otp/input-otp/input-otp.d.ts

@@ -1,133 +0,0 @@
-import { BooleanInput } from '@angular/cdk/coercion';
-import type { NgpInputOtpInput } from '../input-otp-input/input-otp-input';
-import type { NgpInputOtpSlot } from '../input-otp-slot/input-otp-slot';
-import * as i0 from "@angular/core";
-export type NgpInputOtpInputMode = 'numeric' | 'text' | 'decimal' | 'tel' | 'search' | 'email' | 'url';
-export declare class NgpInputOtp {
-    /**
-     * Access the element reference.
-     */
-    readonly elementRef: import("@angular/core").ElementRef<HTMLElement>;
-    /**
-     * The id of the input-otp.
-     */
-    readonly id: import("@angular/core").InputSignal<string>;
-    /**
-     * The current value of the OTP.
-     */
-    readonly value: import("@angular/core").InputSignal<string>;
-    /**
-     * The regex pattern for allowed characters.
-     */
-    readonly pattern: import("@angular/core").InputSignal<string>;
-    /**
-     * The input mode for the hidden input.
-     */
-    readonly inputMode: import("@angular/core").InputSignal<NgpInputOtpInputMode>;
-    /**
-     * Function to transform pasted text.
-     */
-    readonly pasteTransformer: import("@angular/core").InputSignal<((text: string) => string) | undefined>;
-    /**
-     * Whether the input-otp is disabled.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * The placeholder character to display when a slot is empty.
-     */
-    readonly placeholder: import("@angular/core").InputSignal<string>;
-    /**
-     * Event emitted when the value changes.
-     */
-    readonly valueChange: import("@angular/core").OutputEmitterRef<string>;
-    /**
-     * Event emitted when the OTP is complete (maxLength characters entered).
-     */
-    readonly complete: import("@angular/core").OutputEmitterRef<string>;
-    /**
-     * Store the input element reference.
-     * @internal
-     */
-    private readonly inputElement;
-    /**
-     * Store registered slots in order.
-     * @internal
-     */
-    private readonly slots;
-    /**
-     * The number of characters in the OTP, derived from registered slots.
-     */
-    readonly maxLength: import("@angular/core").Signal<number>;
-    /**
-     * The focus state of the input.
-     * @internal
-     */
-    readonly isFocused: import("@angular/core").WritableSignal<boolean>;
-    /**
-     * The selection start position.
-     * @internal
-     */
-    readonly selectionStart: import("@angular/core").WritableSignal<number>;
-    /**
-     * The selection end position.
-     * @internal
-     */
-    readonly selectionEnd: import("@angular/core").WritableSignal<number>;
-    /**
-     * The state of the input-otp.
-     */
-    protected readonly state: import("ng-primitives/state").CreatedState<NgpInputOtp>;
-    constructor();
-    /**
-     * Register an input element with the input-otp.
-     * @param input The input element to register.
-     * @internal
-     */
-    registerInput(input: NgpInputOtpInput): void;
-    /**
-     * Register a slot with the input-otp.
-     * @param slot The slot to register.
-     * @internal
-     */
-    registerSlot(slot: NgpInputOtpSlot): void;
-    /**
-     * Unregister a slot from the input-otp.
-     * @param slot The slot to unregister.
-     * @internal
-     */
-    unregisterSlot(slot: NgpInputOtpSlot): void;
-    /**
-     * Get the index of a registered slot.
-     * @param slot The slot to get the index for.
-     * @returns The index of the slot, or -1 if not found.
-     * @internal
-     */
-    getSlotIndex(slot: NgpInputOtpSlot): number;
-    /**
-     * Update the value and emit change events.
-     * @param newValue The new value.
-     * @internal
-     */
-    updateValue(newValue: string): void;
-    /**
-     * Update focus state.
-     * @param focused Whether the input is focused.
-     * @internal
-     */
-    updateFocus(focused: boolean): void;
-    /**
-     * Update selection state.
-     * @param start Selection start position.
-     * @param end Selection end position.
-     * @internal
-     */
-    updateSelection(start: number, end: number): void;
-    /**
-     * Focus the input and set caret to the specified position.
-     * @param position The position to set the caret to.
-     * @internal
-     */
-    focusAtPosition(position: number): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpInputOtp, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpInputOtp, "[ngpInputOtp]", ["ngpInputOtp"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "value": { "alias": "ngpInputOtpValue"; "required": false; "isSignal": true; }; "pattern": { "alias": "ngpInputOtpPattern"; "required": false; "isSignal": true; }; "inputMode": { "alias": "ngpInputOtpInputMode"; "required": false; "isSignal": true; }; "pasteTransformer": { "alias": "ngpInputOtpPasteTransformer"; "required": false; "isSignal": true; }; "disabled": { "alias": "ngpInputOtpDisabled"; "required": false; "isSignal": true; }; "placeholder": { "alias": "ngpInputOtpPlaceholder"; "required": false; "isSignal": true; }; }, { "valueChange": "ngpInputOtpValueChange"; "complete": "ngpInputOtpComplete"; }, never, never, true, never>;
-}

package/input-otp/input-otp-input/input-otp-input.d.ts

@@ -1,57 +0,0 @@
-import { AfterViewInit } from '@angular/core';
-import * as i0 from "@angular/core";
-import * as i1 from "ng-primitives/a11y";
-export declare class NgpInputOtpInput implements AfterViewInit {
-    /**
-     * Access the element reference.
-     */
-    readonly elementRef: import("@angular/core").ElementRef<HTMLInputElement>;
-    /**
-     * Access the input-otp state.
-     */
-    protected readonly state: import("@angular/core").Signal<import("ng-primitives/state").State<import("ng-primitives/input-otp").NgpInputOtp>>;
-    constructor();
-    ngAfterViewInit(): void;
-    /**
-     * Focus the input.
-     * @internal
-     */
-    focus(): void;
-    /**
-     * Set selection range.
-     * @param start Start position
-     * @param end End position
-     * @internal
-     */
-    setSelectionRange(start: number, end: number): void;
-    /**
-     * Handle input events (typing).
-     */
-    protected onInput(event: Event): void;
-    /**
-     * Handle paste events.
-     */
-    protected onPaste(event: ClipboardEvent): void;
-    /**
-     * Handle focus events.
-     */
-    protected onFocus(): void;
-    /**
-     * Handle blur events.
-     */
-    protected onBlur(): void;
-    /**
-     * Handle keyup events to update selection.
-     */
-    protected onKeyup(): void;
-    /**
-     * Handle selection change events.
-     */
-    protected onSelect(): void;
-    /**
-     * Update the selection state.
-     */
-    private updateSelection;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpInputOtpInput, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpInputOtpInput, "input[ngpInputOtpInput]", ["ngpInputOtpInput"], {}, {}, never, never, true, [{ directive: typeof i1.NgpVisuallyHidden; inputs: {}; outputs: {}; }]>;
-}

package/input-otp/input-otp-slot/input-otp-slot.d.ts

@@ -1,45 +0,0 @@
-import { OnDestroy } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class NgpInputOtpSlot implements OnDestroy {
-    /**
-     * Access the input-otp state.
-     */
-    protected readonly state: import("@angular/core").Signal<import("ng-primitives/state").State<import("ng-primitives/input-otp").NgpInputOtp>>;
-    /**
-     * The computed index of this slot based on registration order.
-     */
-    readonly index: import("@angular/core").Signal<number>;
-    /**
-     * The character for this slot from the value string.
-     */
-    private readonly char;
-    /**
-     * Whether this slot is focused (active).
-     */
-    protected readonly focused: import("@angular/core").Signal<boolean>;
-    /**
-     * Whether this slot should show the caret.
-     */
-    protected readonly caret: import("@angular/core").Signal<boolean>;
-    /**
-     * Whether this slot is filled with a character.
-     */
-    protected readonly filled: import("@angular/core").Signal<boolean>;
-    /**
-     * Whether to show placeholder for this slot.
-     */
-    protected readonly showPlaceholder: import("@angular/core").Signal<boolean>;
-    /**
-     * The display character for this slot (character or placeholder).
-     */
-    protected readonly displayChar: import("@angular/core").Signal<string>;
-    constructor();
-    ngOnDestroy(): void;
-    /**
-     * Handle click events on the slot.
-     * @internal
-     */
-    protected onClick(event: Event): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpInputOtpSlot, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpInputOtpSlot, "[ngpInputOtpSlot]", ["ngpInputOtpSlot"], {}, {}, never, never, true, never>;
-}

package/interactions/config/interactions-config.d.ts

@@ -1,30 +0,0 @@
-import { InjectionToken, Provider } from '@angular/core';
-export interface NgpInteractionsConfig {
-    /** Whether all interactions are disabled */
-    disabled?: boolean;
-    /** Whether hover interactions are enabled */
-    hover?: boolean;
-    /** Whether focus interactions are enabled */
-    focus?: boolean;
-    /** Whether focus-visible interactions are enabled */
-    focusVisible?: boolean;
-    /** Whether press interactions are enabled */
-    press?: boolean;
-}
-export declare const defaultInteractionsConfig: NgpInteractionsConfig;
-export declare const NgpInteractionsConfigToken: InjectionToken<NgpInteractionsConfig>;
-/**
- * Provide the default Interactions configuration
- * @param config The Interactions configuration
- * @returns The provider
- */
-export declare function provideInteractionsConfig(config: Partial<NgpInteractionsConfig>): Provider[];
-/**
- * Inject the Interactions configuration
- * @returns The global Interactions configuration
- */
-export declare function injectInteractionsConfig(): NgpInteractionsConfig;
-export declare function isHoverEnabled(): boolean;
-export declare function isFocusEnabled(): boolean;
-export declare function isFocusVisibleEnabled(): boolean;
-export declare function isPressEnabled(): boolean;

package/interactions/focus/focus-interaction.d.ts

@@ -1,14 +0,0 @@
-import { Signal } from '@angular/core';
-export interface NgpFocusOptions {
-    disabled?: Signal<boolean>;
-    focusWithin?: boolean;
-    focus?: () => void;
-    blur?: () => void;
-}
-export interface NgpFocusState {
-    isFocused: Signal<boolean>;
-}
-/**
- * @internal
- */
-export declare function ngpFocusInteraction({ focus, blur, focusWithin, disabled, }: NgpFocusOptions): NgpFocusState;

package/interactions/focus/focus.d.ts

@@ -1,19 +0,0 @@
-import { BooleanInput } from '@angular/cdk/coercion';
-import * as i0 from "@angular/core";
-/**
- * This was inspired by the React Aria useFocus hook.
- * https://github.com/adobe/react-spectrum/blob/main/packages/%40react-aria/interactions/src/useFocus.ts#L20
- */
-export declare class NgpFocus {
-    /**
-     * Whether listening for focus events is disabled.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Emit when the focus state changes.
-     */
-    readonly focus: import("@angular/core").OutputEmitterRef<boolean>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpFocus, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpFocus, "[ngpFocus]", ["ngpFocus"], { "disabled": { "alias": "ngpFocusDisabled"; "required": false; "isSignal": true; }; }, { "focus": "ngpFocus"; }, never, never, true, never>;
-}

package/interactions/focus-visible/focus-visible-interaction.d.ts

@@ -1,12 +0,0 @@
-import { Signal } from '@angular/core';
-export interface NgpFocusVisibleOptions {
-    disabled?: Signal<boolean>;
-    focusChange?: (value: boolean) => void;
-}
-export interface NgpFocusVisibleState {
-    isFocused: Signal<boolean>;
-}
-/**
- * @internal
- */
-export declare function ngpFocusVisibleInteraction({ focusChange, disabled, }: NgpFocusVisibleOptions): NgpFocusVisibleState;

package/interactions/focus-visible/focus-visible.d.ts

@@ -1,19 +0,0 @@
-import { BooleanInput } from '@angular/cdk/coercion';
-import * as i0 from "@angular/core";
-/**
- * Apply the `ngpFocusVisible` directive to an element that should be visually focused. This is similar to `ngpFocus`
- * but it will only apply the focus visible styles when the element is focused via keyboard navigation.
- */
-export declare class NgpFocusVisible {
-    /**
-     * Whether focus events are listened to.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Emit when the element is visually focused.
-     */
-    readonly focusChange: import("@angular/core").OutputEmitterRef<boolean>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpFocusVisible, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpFocusVisible, "[ngpFocusVisible]", ["ngpFocusVisible"], { "disabled": { "alias": "ngpFocusVisibleDisabled"; "required": false; "isSignal": true; }; }, { "focusChange": "ngpFocusVisible"; }, never, never, true, never>;
-}

package/interactions/hover/hover-interaction.d.ts

@@ -1,17 +0,0 @@
-import { Signal } from '@angular/core';
-interface NgpHoverOptions {
-    disabled?: Signal<boolean>;
-    hoverStart?: () => void;
-    hoverEnd?: () => void;
-}
-export interface NgpHoverState {
-    hovered: Signal<boolean>;
-}
-/**
- * Programatically add the hover functionality to an element.
- * This is useful in cases where we can't necessarily use a HostDirective,
- * because there is a chance the directive has already been used.
- * @internal
- */
-export declare function ngpHoverInteraction({ hoverStart, hoverEnd, disabled, }: NgpHoverOptions): NgpHoverState;
-export {};

package/interactions/hover/hover.d.ts

@@ -1,31 +0,0 @@
-import type { BooleanInput } from '@angular/cdk/coercion';
-import * as i0 from "@angular/core";
-/**
- * Apply the `ngpHover` directive to an element that you want to listen for hover events. T
- * his is particulaly useful for supporting hover events on touch devices, where hover events are not handled consistently.
- * On iOS relying on the `:hover` pseudo-class can result in the hover state being stuck until the user taps elsewhere on the screen.
- */
-export declare class NgpHover {
-    /**
-     * Whether hoving should be disabled.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Emit an event when hovering starts.
-     */
-    readonly hoverStart: import("@angular/core").OutputEmitterRef<void>;
-    /**
-     * Emit an event when hovering ends.
-     */
-    readonly hoverEnd: import("@angular/core").OutputEmitterRef<void>;
-    /**
-     * Emit an event when the hover state changes.
-     */
-    readonly hoverChange: import("@angular/core").OutputEmitterRef<boolean>;
-    /**
-     * Setup the hover state.
-     */
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpHover, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpHover, "[ngpHover]", ["ngpHover"], { "disabled": { "alias": "ngpHoverDisabled"; "required": false; "isSignal": true; }; }, { "hoverStart": "ngpHoverStart"; "hoverEnd": "ngpHoverEnd"; "hoverChange": "ngpHover"; }, never, never, true, never>;
-}

package/interactions/interactions/interactions.d.ts

@@ -1,20 +0,0 @@
-import { Signal } from '@angular/core';
-export interface NgpInteractionOptions {
-    hover?: boolean;
-    press?: boolean;
-    focus?: boolean;
-    focusWithin?: boolean;
-    focusVisible?: boolean;
-    disabled?: Signal<boolean>;
-}
-/**
- * Setup the interactions without relying on HostDirectives.
- * @internal
- */
-export declare function ngpInteractions({ focus, hover, press, focusWithin, focusVisible, disabled, }: NgpInteractionOptions): void;
-/**
- * This function checks to see if a given interaction has already been setup on a given element.
- * If it has, it returns the existing interaction state.
- * If it has not, it sets up the interaction state for future checks.
- */
-export declare function hasInteraction(element: HTMLElement, interaction: string): boolean;

package/interactions/move/move.d.ts

@@ -1,114 +0,0 @@
-import { BooleanInput } from '@angular/cdk/coercion';
-import * as i0 from "@angular/core";
-/**
- * The `NgpMove` directive is used to enable the pointer and keyboard move interactions on an element.
- */
-export declare class NgpMove {
-    /**
-     * Access the disposable helper.
-     */
-    private readonly disposables;
-    /**
-     * Whether movement is disabled.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Emit when the move event begins.
-     */
-    readonly start: import("@angular/core").OutputEmitterRef<NgpMoveBaseEvent>;
-    /**
-     * Emit when the element is moved.
-     */
-    readonly move: import("@angular/core").OutputEmitterRef<NgpMoveEvent>;
-    /**
-     * Emit when the move event ends.
-     */
-    readonly end: import("@angular/core").OutputEmitterRef<NgpMoveBaseEvent>;
-    /**
-     * Whether the element is currently being moved.
-     */
-    private isMoving;
-    /**
-     * Store the last x position of the element.
-     */
-    private x;
-    /**
-     * Store the last y position of the element.
-     */
-    private y;
-    /**
-     * Store the id of the last pointer.
-     */
-    private pointerId;
-    /**
-     * Store the disposable event listeners.
-     */
-    private disposableListeners;
-    /**
-     * Handle a move start.
-     */
-    private onMoveStart;
-    /**
-     * Handle a move event.
-     */
-    private onMove;
-    /**
-     * Handle a move end.
-     */
-    private onMoveEnd;
-    /**
-     * Handle the pointer down event.
-     */
-    protected onPointerDown(event: PointerEvent): void;
-    /**
-     * Handle the pointer up event.
-     */
-    protected onPointerUp(event: PointerEvent): void;
-    /**
-     * Handle the pointer move event.
-     */
-    protected onPointerMove(event: PointerEvent): void;
-    private triggerKeyboardMove;
-    protected onArrowUp(event: KeyboardEvent): void;
-    protected onArrowDown(event: KeyboardEvent): void;
-    protected onArrowLeft(event: KeyboardEvent): void;
-    protected onArrowRight(event: KeyboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpMove, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpMove, "[ngpMove]", ["ngpMove"], { "disabled": { "alias": "ngpMoveDisabled"; "required": false; "isSignal": true; }; }, { "start": "ngpMoveStart"; "move": "ngpMove"; "end": "ngpMoveEnd"; }, never, never, true, never>;
-}
-interface NgpMoveBaseEvent {
-    /**
-     * Whether the event was triggered by a mouse or keyboard event.
-     */
-    pointerType: PointerType;
-    /**
-     * Whether the shift key was pressed during the event.
-     */
-    shiftKey: boolean;
-    /**
-     * Whether the control key was pressed during the event.
-     */
-    ctrlKey: boolean;
-    /**
-     * Whether the meta key was pressed during the event.
-     */
-    metaKey: boolean;
-    /**
-     * Whether the alt key was pressed during the event.
-     */
-    altKey: boolean;
-}
-export type NgpMoveStartEvent = NgpMoveBaseEvent;
-export type NgpMoveEndEvent = NgpMoveBaseEvent;
-export interface NgpMoveEvent extends NgpMoveBaseEvent {
-    /**
-     * The amount of pixels moved in the x-axis.
-     */
-    deltaX: number;
-    /**
-     * The amount of pixels moved in the y-axis.
-     */
-    deltaY: number;
-}
-export type PointerType = 'mouse' | 'pen' | 'touch' | 'keyboard' | 'virtual';
-export {};

package/interactions/press/press-interaction.d.ts

@@ -1,14 +0,0 @@
-import { Signal } from '@angular/core';
-interface NgpPressState {
-    pressed: Signal<boolean>;
-}
-interface NgpPressOptions {
-    disabled?: Signal<boolean>;
-    pressStart?: () => void;
-    pressEnd?: () => void;
-}
-/**
- * @internal
- */
-export declare function ngpPressInteraction({ pressStart, pressEnd, disabled, }: NgpPressOptions): NgpPressState;
-export {};

package/interactions/press/press.d.ts

@@ -1,26 +0,0 @@
-import { BooleanInput } from '@angular/cdk/coercion';
-import * as i0 from "@angular/core";
-/**
- * The `ngpPress` directive listens for press events on an element. This is particularly useful for supporting press events on touch devices, where press events are not handled consistently.
- */
-export declare class NgpPress {
-    /**
-     * Whether listening for press events is disabled.
-     */
-    readonly disabled: import("@angular/core").InputSignalWithTransform<boolean, BooleanInput>;
-    /**
-     * Emit when the press begins.
-     */
-    readonly pressStart: import("@angular/core").OutputEmitterRef<void>;
-    /**
-     * Emit when the press ends.
-     */
-    readonly pressEnd: import("@angular/core").OutputEmitterRef<void>;
-    /**
-     * Emit when the press changes.
-     */
-    readonly pressChange: import("@angular/core").OutputEmitterRef<boolean>;
-    constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpPress, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpPress, "[ngpPress]", ["ngpPress"], { "disabled": { "alias": "ngpPressDisabled"; "required": false; "isSignal": true; }; }, { "pressStart": "ngpPressStart"; "pressEnd": "ngpPressEnd"; "pressChange": "ngpPress"; }, never, never, true, never>;
-}

package/internal/exit-animation/exit-animation-manager.d.ts

@@ -1,17 +0,0 @@
-import { ClassProvider } from '@angular/core';
-import type { NgpExitAnimation } from './exit-animation';
-import * as i0 from "@angular/core";
-export declare class NgpExitAnimationManager {
-    /** Store the instances of the exit animation directive. */
-    private readonly instances;
-    /** Add an instance to the manager. */
-    add(instance: NgpExitAnimation): void;
-    /** Remove an instance from the manager. */
-    remove(instance: NgpExitAnimation): void;
-    /** Exit all instances. */
-    exit(): Promise<void>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpExitAnimationManager, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgpExitAnimationManager>;
-}
-export declare function provideExitAnimationManager(): ClassProvider;
-export declare function injectExitAnimationManager(): NgpExitAnimationManager;

package/internal/exit-animation/exit-animation.d.ts

@@ -1,26 +0,0 @@
-import { OnDestroy } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class NgpExitAnimation implements OnDestroy {
-    /** The animation manager. */
-    private readonly animationManager;
-    /** Access the element reference. */
-    protected readonly elementRef: import("@angular/core").ElementRef<HTMLElement>;
-    /** Exist animation reference. */
-    protected readonly ref: NgpExitAnimationRef;
-    constructor();
-    ngOnDestroy(): void;
-    /** Mark the element as exiting. */
-    exit(): Promise<void>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgpExitAnimation, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgpExitAnimation, "[ngpExitAnimation]", ["ngpExitAnimation"], {}, {}, never, never, true, never>;
-}
-interface NgpExitAnimationOptions {
-    /** The element to animate. */
-    element: HTMLElement;
-}
-export interface NgpExitAnimationRef {
-    /** Mark the element as exiting and wait for the animation to finish. */
-    exit: () => Promise<void>;
-}
-export declare function setupExitAnimation({ element }: NgpExitAnimationOptions): NgpExitAnimationRef;
-export {};

package/internal/signals/explicit-effect.d.ts

@@ -1,19 +0,0 @@
-/**
- * This implementation is heavily inspired by the great work on ngextension!
- * https://github.com/ngxtension/ngxtension-platform/blob/main/libs/ngxtension/explicit-effect/src/explicit-effect.ts
- */
-import { CreateEffectOptions, EffectCleanupRegisterFn, EffectRef } from '@angular/core';
-/**
- * We want to have the Tuple in order to use the types in the function signature
- */
-type ExplicitEffectValues<T> = {
-    [K in keyof T]: () => T[K];
-};
-/**
- * This explicit effect function will take the dependencies and the function to run when the dependencies change.
- * @param deps - The dependencies that the effect will run on
- * @param fn - The function to run when the dependencies change
- * @param options - The options for the effect with the addition of defer (it allows the computation to run on first change, not immediately)
- */
-export declare function explicitEffect<Input extends readonly unknown[], Params = Input>(deps: readonly [...ExplicitEffectValues<Input>], fn: (deps: Params, onCleanup: EffectCleanupRegisterFn) => void, options?: CreateEffectOptions): EffectRef;
-export {};