@w3ux/hooks 2.2.2 → 2.3.0

package/index.d.cts

@@ -0,0 +1,41 @@
+import { RefObject, Context } from 'react';
+import { UseTimeleftProps, TimeLeftAll } from '@w3ux/types';
+
+declare const useEffectIgnoreInitial: <T, U>(fn: T, deps: U[]) => void;
+
+interface UseOnResizeOptions {
+    outerElement?: RefObject<HTMLElement | null>;
+    throttle?: number;
+}
+/**
+ * Custom hook that triggers a callback function when the specified element
+ * or the window is resized.
+ *
+ * @param callback - The function to be executed on resize.
+ * @param options - Optional parameters to customize the behavior:
+ *   - outerElement: A ref to an HTMLElement to listen for resize events.
+ *   - throttle: Optional duration in milliseconds to throttle the callback execution.
+ *               Default is 100 milliseconds.
+ */
+declare const useOnResize: (callback: () => void, options?: UseOnResizeOptions) => void;
+
+declare const useOutsideAlerter: (ref: RefObject<HTMLElement | null>, callback: () => void, ignore?: string[]) => void;
+
+declare const useSafeContext: <T>(ctx: T | null | undefined) => T;
+declare const createSafeContext: <T>() => [Context<T | null>, () => T];
+
+interface UseSizeOptions {
+    outerElement?: RefObject<HTMLElement | null>;
+    throttle?: number;
+}
+declare const useSize: (element: RefObject<HTMLElement | null>, options?: UseSizeOptions) => {
+    width: number;
+    height: number;
+};
+
+declare const useTimeLeft: (props?: UseTimeleftProps) => {
+    setFromNow: (dateFrom: Date, dateTo: Date) => void;
+    timeleft: TimeLeftAll;
+};
+
+export { createSafeContext, useEffectIgnoreInitial, useOnResize, useOutsideAlerter, useSafeContext, useSize, useTimeLeft };

package/index.d.ts

@@ -0,0 +1,41 @@
+import { RefObject, Context } from 'react';
+import { UseTimeleftProps, TimeLeftAll } from '@w3ux/types';
+
+declare const useEffectIgnoreInitial: <T, U>(fn: T, deps: U[]) => void;
+
+interface UseOnResizeOptions {
+    outerElement?: RefObject<HTMLElement | null>;
+    throttle?: number;
+}
+/**
+ * Custom hook that triggers a callback function when the specified element
+ * or the window is resized.
+ *
+ * @param callback - The function to be executed on resize.
+ * @param options - Optional parameters to customize the behavior:
+ *   - outerElement: A ref to an HTMLElement to listen for resize events.
+ *   - throttle: Optional duration in milliseconds to throttle the callback execution.
+ *               Default is 100 milliseconds.
+ */
+declare const useOnResize: (callback: () => void, options?: UseOnResizeOptions) => void;
+
+declare const useOutsideAlerter: (ref: RefObject<HTMLElement | null>, callback: () => void, ignore?: string[]) => void;
+
+declare const useSafeContext: <T>(ctx: T | null | undefined) => T;
+declare const createSafeContext: <T>() => [Context<T | null>, () => T];
+
+interface UseSizeOptions {
+    outerElement?: RefObject<HTMLElement | null>;
+    throttle?: number;
+}
+declare const useSize: (element: RefObject<HTMLElement | null>, options?: UseSizeOptions) => {
+    width: number;
+    height: number;
+};
+
+declare const useTimeLeft: (props?: UseTimeleftProps) => {
+    setFromNow: (dateFrom: Date, dateTo: Date) => void;
+    timeleft: TimeLeftAll;
+};
+
+export { createSafeContext, useEffectIgnoreInitial, useOnResize, useOutsideAlerter, useSafeContext, useSize, useTimeLeft };