@plurid/plurid-functions-react 0.0.0-4 → 0.0.0-6

package/distribution/index.d.mts

@@ -0,0 +1,74 @@
+import React from 'react';
+
+declare const useWindowEvent: (event: any, callback: any) => void;
+declare const useElementEvent: (event: any, element: any, callback: any) => void;
+declare const useGlobalKeyDown: (callback: any, element?: any) => void;
+declare const useGlobalWheel: (callback: any, element?: any) => void;
+
+/**
+ * Source: https://stackoverflow.com/a/57335271
+ *
+ * @param callback Function to be called.
+ * @param wait Debounce time.
+ */
+declare function useDebouncedCallback<A extends any[]>(callback: (...args: A) => void, wait: number): (...args: A) => void;
+
+/**
+ * @param callback
+ * @param delay
+ */
+declare const useThrottledCallback: <A extends any[]>(callback: (...args: A) => void, delay: number) => (...args: A) => void;
+
+/**
+ * Based on
+ * https://www.jayfreestone.com/writing/react-portals-with-hooks/
+ *
+ */
+/**
+ * Hook to create a React Portal.
+ * Automatically handles creating and tearing-down the root elements (no SRR
+ * makes this trivial), so there is no need to ensure the parent target already
+ * exists.
+ * @example
+ * const target = usePortal(id, [id]);
+ * return createPortal(children, target);
+ *
+ * @param id    The id of the target container, e.g 'modal' or 'spotlight'
+ * @returns     The DOM node to use as the Portal target.
+ */
+declare const usePortal: (id: string, parentID: string) => any;
+
+/**
+ * After a `true` dispatch, it will wait the `intervalTime` and autoset to `false`.
+ *
+ * @param intervalTime
+ * @returns
+ */
+declare const useFalseAfterTimedTrue: (intervalTime?: number) => [boolean, React.Dispatch<React.SetStateAction<boolean>>];
+/**
+ * Keeps reference of the current mounted component.
+ *
+ * @returns
+ */
+declare const useMounted: () => boolean;
+
+declare const createMarkup: (text: string) => {
+    __html: string;
+};
+
+/**
+ * Merges multiple references into one `ref` attribute.
+ *
+ * ``` jsx
+ * <SomeComponent
+ *     ref={merge(ref1, ref2)}
+ * />
+ * ```
+ *
+ * Source: https://www.davedrinks.coffee/how-do-i-use-two-react-refs/
+ *
+ * @param refs
+ */
+declare const mergeReferences: (...refs: any[]) => any;
+
+export { createMarkup, mergeReferences, useDebouncedCallback, useElementEvent, useFalseAfterTimedTrue, useGlobalKeyDown, useGlobalWheel, useMounted, usePortal, useThrottledCallback, useWindowEvent };

package/distribution/index.d.ts

@@ -1,2 +1,74 @@
-export * from './hooks';
-export * from './utilities';
+import React from 'react';
+
+declare const useWindowEvent: (event: any, callback: any) => void;
+declare const useElementEvent: (event: any, element: any, callback: any) => void;
+declare const useGlobalKeyDown: (callback: any, element?: any) => void;
+declare const useGlobalWheel: (callback: any, element?: any) => void;
+
+/**
+ * Source: https://stackoverflow.com/a/57335271
+ *
+ * @param callback Function to be called.
+ * @param wait Debounce time.
+ */
+declare function useDebouncedCallback<A extends any[]>(callback: (...args: A) => void, wait: number): (...args: A) => void;
+
+/**
+ * @param callback
+ * @param delay
+ */
+declare const useThrottledCallback: <A extends any[]>(callback: (...args: A) => void, delay: number) => (...args: A) => void;
+
+/**
+ * Based on
+ * https://www.jayfreestone.com/writing/react-portals-with-hooks/
+ *
+ */
+/**
+ * Hook to create a React Portal.
+ * Automatically handles creating and tearing-down the root elements (no SRR
+ * makes this trivial), so there is no need to ensure the parent target already
+ * exists.
+ * @example
+ * const target = usePortal(id, [id]);
+ * return createPortal(children, target);
+ *
+ * @param id    The id of the target container, e.g 'modal' or 'spotlight'
+ * @returns     The DOM node to use as the Portal target.
+ */
+declare const usePortal: (id: string, parentID: string) => any;
+
+/**
+ * After a `true` dispatch, it will wait the `intervalTime` and autoset to `false`.
+ *
+ * @param intervalTime
+ * @returns
+ */
+declare const useFalseAfterTimedTrue: (intervalTime?: number) => [boolean, React.Dispatch<React.SetStateAction<boolean>>];
+/**
+ * Keeps reference of the current mounted component.
+ *
+ * @returns
+ */
+declare const useMounted: () => boolean;
+
+declare const createMarkup: (text: string) => {
+    __html: string;
+};
+
+/**
+ * Merges multiple references into one `ref` attribute.
+ *
+ * ``` jsx
+ * <SomeComponent
+ *     ref={merge(ref1, ref2)}
+ * />
+ * ```
+ *
+ * Source: https://www.davedrinks.coffee/how-do-i-use-two-react-refs/
+ *
+ * @param refs
+ */
+declare const mergeReferences: (...refs: any[]) => any;
+
+export { createMarkup, mergeReferences, useDebouncedCallback, useElementEvent, useFalseAfterTimedTrue, useGlobalKeyDown, useGlobalWheel, useMounted, usePortal, useThrottledCallback, useWindowEvent };