@ethlete/core 4.12.1 → 4.14.0

package/lib/directives/animated-lifecycle/animated-lifecycle.directive.d.ts

@@ -13,10 +13,10 @@ export declare class AnimatedLifecycleDirective implements AfterViewInit {
     readonly state$: import("rxjs").Observable<AnimatedLifecycleState>;
     get state(): AnimatedLifecycleState;
     readonly hostClassBindings: {
-        remove: (...tokens: string[]) => void;
+        remove: (tokens: string) => void;
         removeMany: (tokens: string[]) => void;
-        has: (token: string) => boolean;
-        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        has: (tokens: string) => boolean;
+        push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
         pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
     };
     stateChange: import("@angular/core").OutputRef<AnimatedLifecycleState>;

package/lib/props/create-prop-handlers.d.ts

@@ -1,24 +1,24 @@
 import { ElementRef } from '@angular/core';
 export declare const createPropHandlers: () => {
     classes: {
-        remove: (...tokens: string[]) => void;
+        remove: (tokens: string) => void;
         removeMany: (tokens: string[]) => void;
-        has: (token: string) => boolean;
-        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        has: (tokens: string) => boolean;
+        push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
         pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
     };
     attributes: {
-        remove: (...tokens: string[]) => void;
+        remove: (tokens: string) => void;
         removeMany: (tokens: string[]) => void;
-        has: (token: string) => boolean;
-        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        has: (tokens: string) => boolean;
+        push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
         pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
     };
     styles: {
-        remove: (...tokens: string[]) => void;
+        remove: (tokens: string) => void;
         removeMany: (tokens: string[]) => void;
-        has: (token: string) => boolean;
-        push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+        has: (tokens: string) => boolean;
+        push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
         pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
     };
     id: string;

package/lib/props/props.directive.d.ts

@@ -9,24 +9,24 @@ export declare class PropsDirective {
     }>>;
     propHandlers: {
         classes: {
-            remove: (...tokens: string[]) => void;
+            remove: (tokens: string) => void;
             removeMany: (tokens: string[]) => void;
-            has: (token: string) => boolean;
-            push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+            has: (tokens: string) => boolean;
+            push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
             pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
         };
         attributes: {
-            remove: (...tokens: string[]) => void;
+            remove: (tokens: string) => void;
             removeMany: (tokens: string[]) => void;
-            has: (token: string) => boolean;
-            push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+            has: (tokens: string) => boolean;
+            push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
             pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
         };
         styles: {
-            remove: (...tokens: string[]) => void;
+            remove: (tokens: string) => void;
             removeMany: (tokens: string[]) => void;
-            has: (token: string) => boolean;
-            push: (tokenString: string, signal: import("@angular/core").Signal<unknown>) => void;
+            has: (tokens: string) => boolean;
+            push: (tokens: string, signal: import("@angular/core").Signal<unknown>) => void;
             pushMany: (map: Record<string, import("@angular/core").Signal<unknown>>) => void;
         };
         id: string;

package/lib/utils/signal.utils.d.ts

@@ -1,72 +1,72 @@
-import { ElementRef, Injector, QueryList, Signal, WritableSignal } from '@angular/core';
+import { EffectRef, ElementRef, Injector, QueryList, Signal, WritableSignal } from '@angular/core';
 import { FormArray, FormControl, FormGroup } from '@angular/forms';
 import { Observable } from 'rxjs';
 type SignalElementBindingComplexType = HTMLElement | ElementRef<HTMLElement> | QueryList<ElementRef<HTMLElement> | HTMLElement> | Array<ElementRef<HTMLElement> | HTMLElement> | null | undefined;
 type SignalElementBindingType = HTMLElement | ElementRef<HTMLElement> | Observable<SignalElementBindingComplexType> | Signal<SignalElementBindingComplexType> | QueryList<ElementRef<HTMLElement> | HTMLElement> | ElementSignal;
 type ElementSignal = Signal<{
+    /** @deprecated Always use currentElements  */
     currentElement: HTMLElement | null;
+    /** @deprecated Always use previousElements  */
     previousElement: HTMLElement | null;
     currentElements: HTMLElement[];
     previousElements: HTMLElement[];
 }>;
-export declare const buildSignalEffects: <T extends Record<string, Signal<unknown>>>(config: {
-    map: T;
-    eachItemFn: (pair: {
-        key: string;
-        value: unknown;
-    }) => void;
-    cleanupFn: (pair: {
-        key: string;
-        value: unknown;
-    }) => void;
-}) => {
-    remove: (...tokens: string[]) => void;
+export interface BuildSignalEffectsConfig<T extends Record<string, Signal<unknown>>> {
+    /** The tokens to apply and their signal value  */
+    tokenMap: T;
+    /** This function will be invoked for elements that were removed from the signal effects */
+    cleanupFn: (el: HTMLElement, tokens: string[]) => void;
+    /** This function will be invoked for elements that were added to the signal effects or when their signal value changes */
+    updateFn: (el: HTMLElement, tokens: string[], conditionResult: unknown) => void;
+}
+export declare const buildSignalEffects: <T extends Record<string, Signal<unknown>>>(el: SignalElementBindingType, config: BuildSignalEffectsConfig<T>) => {
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalIsRendered: () => Signal<boolean>;
 export declare const signalClasses: <T extends Record<string, Signal<unknown>>>(el: SignalElementBindingType, classMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalHostClasses: <T extends Record<string, Signal<unknown>>>(classMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalAttributes: <T extends Record<string, Signal<unknown>>>(el: SignalElementBindingType, attributeMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalHostAttributes: <T extends Record<string, Signal<unknown>>>(attributeMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalStyles: <T extends Record<string, Signal<unknown>>>(el: SignalElementBindingType, styleMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export declare const signalHostStyles: <T extends Record<string, Signal<unknown>>>(styleMap: T) => {
-    remove: (...tokens: string[]) => void;
+    remove: (tokens: string) => void;
     removeMany: (tokens: string[]) => void;
-    has: (token: string) => boolean;
-    push: (tokenString: string, signal: Signal<unknown>) => void;
+    has: (tokens: string) => boolean;
+    push: (tokens: string, signal: Signal<unknown>) => void;
     pushMany: (map: Record<string, Signal<unknown>>) => void;
 };
 export interface LogicalSize {
@@ -83,7 +83,14 @@ export declare const signalElementDimensions: (el: SignalElementBindingType) =>
 export declare const signalHostElementDimensions: () => Signal<ElementDimensions>;
 export declare const signalElementMutations: (el: SignalElementBindingType, options?: MutationObserverInit) => Signal<MutationRecord | null>;
 export declare const signalHostElementMutations: (options?: MutationObserverInit) => Signal<MutationRecord | null>;
-export declare const signalElementScrollState: (el: SignalElementBindingType) => Signal<{
+export type SignalElementScrollStateOptions = {
+    /** The initial scroll position to scroll to. Once a truthy value get's emitted, all further values will be ignored. */
+    initialScrollPosition?: Signal<{
+        x: number;
+        y: number;
+    } | null>;
+};
+export declare const signalElementScrollState: (el: SignalElementBindingType, options?: SignalElementScrollStateOptions) => Signal<{
     canScroll: boolean;
     canScrollHorizontally: boolean;
     canScrollVertically: boolean;
@@ -166,4 +173,11 @@ export declare const injectQueryParam: <T = string | null>(key: string, config?:
 export declare const injectRouteDataItem: <T = unknown>(key: string, config?: InjectUtilConfig & InjectUtilTransformConfig<unknown, T>) => Signal<T>;
 /** Inject a specific path parameter as a signal */
 export declare const injectPathParam: <T = string | null>(key: string, config?: InjectUtilConfig & InjectUtilTransformConfig<string | null, T>) => Signal<T>;
+export declare const createIsRenderedSignal: () => {
+    state: WritableSignal<boolean>;
+    bind: () => EffectRef;
+};
+export declare const createCanAnimateSignal: () => {
+    state: WritableSignal<boolean>;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/core",
-  "version": "4.12.1",
+  "version": "4.14.0",
   "peerDependencies": {
     "@angular/cdk": "17.3.6",
     "@angular/common": "17.3.6",