@ethlete/core 4.18.4 → 4.19.1

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

@@ -74,36 +74,48 @@ export interface LogicalSize {
     inlineSize: number;
     blockSize: number;
 }
-export interface ElementDimensions {
-    rect: DOMRectReadOnly | null;
-    borderBoxSize: LogicalSize | null;
-    contentBoxSize: LogicalSize | null;
-    devicePixelContentBoxSize: LogicalSize | null;
-}
-export declare const signalElementDimensions: (el: SignalElementBindingType) => Signal<ElementDimensions>;
-export declare const signalHostElementDimensions: () => Signal<ElementDimensions>;
+export type ElementRect = {
+    bottom: number;
+    height: number;
+    left: number;
+    right: number;
+    top: number;
+    width: number;
+    x: number;
+    y: number;
+};
+export type ElementSize = {
+    width: number;
+    height: number;
+};
+export declare const boundingClientRectToElementRect: (rect: DOMRectReadOnly) => ElementRect;
+export declare const createElementDimensions: (el: HTMLElement | null, rect?: DOMRect) => NullableElementDimensions;
+export type ElementDimensions = {
+    rect: ElementRect;
+    client: ElementSize;
+    scroll: ElementSize;
+    offset: ElementSize;
+};
+export type NullableElementDimensions = {
+    [K in keyof ElementDimensions]: ElementDimensions[K] | null;
+};
+export declare const signalElementDimensions: (el: SignalElementBindingType) => Signal<NullableElementDimensions>;
+export declare const signalHostElementDimensions: () => Signal<NullableElementDimensions>;
 export declare const signalElementMutations: (el: SignalElementBindingType, options?: MutationObserverInit) => Signal<MutationRecord | null>;
 export declare const signalHostElementMutations: (options?: MutationObserverInit) => Signal<MutationRecord | null>;
 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<ScrollToOptions | null>;
 };
-export declare const signalElementScrollState: (el: SignalElementBindingType, options?: SignalElementScrollStateOptions) => Signal<{
+export type ElementScrollState = {
     canScroll: boolean;
     canScrollHorizontally: boolean;
     canScrollVertically: boolean;
-    scrollWidth: number | null;
-    scrollHeight: number | null;
-    elementDimensions: ElementDimensions;
-}>;
-export declare const signalHostElementScrollState: () => Signal<{
-    canScroll: boolean;
-    canScrollHorizontally: boolean;
-    canScrollVertically: boolean;
-    scrollWidth: number | null;
-    scrollHeight: number | null;
-    elementDimensions: ElementDimensions;
-}>;
+    elementDimensions: NullableElementDimensions;
+};
+export declare const areScrollStatesEqual: (a: ElementScrollState, b: ElementScrollState) => boolean;
+export declare const signalElementScrollState: (el: SignalElementBindingType, options?: SignalElementScrollStateOptions) => Signal<ElementScrollState>;
+export declare const signalHostElementScrollState: () => Signal<ElementScrollState>;
 export type SignalElementIntersectionOptions = Omit<IntersectionObserverInit, 'root'> & {
     root?: SignalElementBindingType;
     enabled?: Signal<boolean>;
@@ -205,6 +217,11 @@ export declare const computedTillTruthy: <T>(source: Signal<T>) => Signal<T | nu
  * All subsequent changes inside the computation will be ignored.
  */
 export declare const computedTillFalsy: <T>(source: Signal<T>) => Signal<T | null>;
+/**
+ * A writeable signal that will be set to the provided value once all inputs are set.
+ * During that time, the signal will be set to `null`.
+ */
+export declare const deferredSignal: <T extends () => unknown>(valueFn: T) => WritableSignal<ReturnType<T> | null>;
 /** Inject a signal containing a boolean value indicating if the viewport is xs */
 export declare const injectIsXs: () => Signal<boolean>;
 /** Inject a signal containing a boolean value indicating if the viewport is sm */

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@ethlete/core",
-  "version": "4.18.4",
+  "version": "4.19.1",
   "peerDependencies": {
-    "@angular/cdk": "17.3.8",
-    "@angular/common": "17.3.8",
-    "@angular/core": "17.3.8",
-    "@angular/forms": "17.3.8",
-    "@angular/platform-browser": "17.3.8",
-    "@angular/router": "17.3.8",
+    "@angular/cdk": "17.3.9",
+    "@angular/common": "17.3.9",
+    "@angular/core": "17.3.9",
+    "@angular/forms": "17.3.9",
+    "@angular/platform-browser": "17.3.9",
+    "@angular/router": "17.3.9",
     "@ethlete/theming": "^2.3.1",
     "@ethlete/types": "^1.6.2",
     "@floating-ui/dom": "^1.5.3",