@siberiacancode/reactuse 0.0.24 → 0.0.26

package/dist/index.d.ts

@@ -189,12 +189,37 @@ declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultVa
  * @param {React.DependencyList} [deps] The dependencies list for the effect
  *
  * @example
- * useDidUpdate(() => {
- *   console.log('Won't be called when mounted');
- * }, [deps]);
+ * useDidUpdate(() => console.log('Won't be called when mounted'), [deps]);
  */
 declare const useDidUpdate: (effect: React.EffectCallback, deps?: React.DependencyList) => void;
 
+type UseEventListenerTarget = React.RefObject<Element | null> | (() => Element) | Element | Window | Document;
+type UseEventListenerOptions = boolean | AddEventListenerOptions;
+type UseEventListenerReturn<Target extends UseEventListenerTarget> = React.RefObject<Target>;
+type UseEventListener = {
+    <Event extends keyof WindowEventMap = keyof WindowEventMap>(target: Window, event: Event | Event[], listener: (this: Window, event: WindowEventMap[Event]) => void, options?: UseEventListenerOptions): void;
+    <Event extends keyof DocumentEventMap = keyof DocumentEventMap>(target: Document, event: Event | Event[], listener: (this: Document, event: DocumentEventMap[Event]) => void, options?: UseEventListenerOptions): void;
+    <Target extends UseEventListenerTarget, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(target: Target, event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions): void;
+    <Target extends Element, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
+    <Target extends Element, Event extends keyof MediaQueryListEventMap = keyof MediaQueryListEventMap>(event: Event | Event[], listener: (this: Target, event: MediaQueryListEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
+};
+declare const useEventListener: UseEventListener;
+
+/**
+ * @name useDocumentEvent
+ * @description - Hook attaches an event listener to the document object for the specified event
+ *
+ * @template Event Key of document event map.
+ * @param {Event} event The event to listen for.
+ * @param {(event: DocumentEventMap[Event]) => void} listener The callback function to be executed when the event is triggered
+ * @param {UseEventListenerOptions} [options] The options for the event listener
+ * @returns {void}
+ *
+ * @example
+ * useDocumentEvent('click', () => console.log('clicked'));
+ */
+declare const useDocumentEvent: <Event extends keyof DocumentEventMap>(event: Event, listener: (this: Document, event: DocumentEventMap[Event]) => any, options?: UseEventListenerOptions) => void;
+
 /** The use document title options type */
 interface UseDocumentTitleOptions {
     /** Restore the previous title on unmount */
@@ -245,17 +270,23 @@ declare const useDocumentVisibility: () => DocumentVisibilityState;
  */
 declare const useEvent: <Params extends unknown[], Return>(callback: (...args: Params) => Return) => ((...args: Params) => Return);
 
-type UseEventListenerTarget = React.RefObject<Element | null> | (() => Element) | Element | Window | Document;
-type UseEventListenerOptions = boolean | AddEventListenerOptions;
-type UseEventListenerReturn<Target extends UseEventListenerTarget> = React.RefObject<Target>;
-type UseEventListener = {
-    <Event extends keyof WindowEventMap = keyof WindowEventMap>(target: Window, event: Event | Event[], listener: (this: Window, event: WindowEventMap[Event]) => void, options?: UseEventListenerOptions): void;
-    <Event extends keyof DocumentEventMap = keyof DocumentEventMap>(target: Document, event: Event | Event[], listener: (this: Document, event: DocumentEventMap[Event]) => void, options?: UseEventListenerOptions): void;
-    <Target extends UseEventListenerTarget, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(target: Target, event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions): void;
-    <Target extends Element, Event extends keyof HTMLElementEventMap = keyof HTMLElementEventMap>(event: Event | Event[], listener: (this: Target, event: HTMLElementEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
-    <Target extends Element, Event extends keyof MediaQueryListEventMap = keyof MediaQueryListEventMap>(event: Event | Event[], listener: (this: Target, event: MediaQueryListEventMap[Event]) => void, options?: UseEventListenerOptions, target?: never): UseEventListenerReturn<Target>;
-};
-declare const useEventListener: UseEventListener;
+/** The color selection return type */
+interface UseEyeDropperReturn {
+    supported: boolean;
+    value?: string;
+    open: (colorSelectionOptions?: ColorSelectionOptions) => Promise<ColorSelectionResult>;
+}
+/**
+ * @name useEyeDropper
+ * @description - Hook that gives you access to the eye dropper
+ *
+ * @param {string} [initialValue=undefined] The initial value for the eye dropper
+ * @returns {UseEyeDropperReturn} An object containing the supported status, the value and the open method
+ *
+ * @example
+ * const { supported, value, open } = useEyeDropper();
+ */
+declare const useEyeDropper: (initialValue?: string | undefined) => UseEyeDropperReturn;
 
 /** The use favicon return type */
 type UseFaviconReturn = [string, React.Dispatch<React.SetStateAction<string>>];
@@ -926,12 +957,13 @@ declare const useOrientation: () => UseOrientationReturn;
  * @name usePageLeave
  * @description - Hook what calls given function when mouse leaves the page
  *
- * @param {() => void} callback The callback function what calls then mouse leaves the page
+ * @param {() => void} [callback] The callback function what calls then mouse leaves the page
+ * @returns {boolean} A boolean which determines if the mouse left the page
  *
  * @example
- * usePageLeave(() => console.log('on leave'))
+ * const isLeft = usePageLeave(() => console.log('on leave'))
  */
-declare const usePageLeave: (callback: () => void) => void;
+declare const usePageLeave: (callback?: () => void) => boolean;
 
 interface UsePaintPencil {
     /** Pencil color */
@@ -1411,4 +1443,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseListReturn, type UseLongPress, type UseLongPressReturn, type UseLongPressTarget, type UseMouse, type UseMouseReturn, type UseNetworkReturn, type UseOrientationReturn, type UsePaint, type UsePaintOptions, type UsePaintPencil, type UsePaintReturn, type UsePaintTarget, type UsePreferredColorSchemeReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseToggleReturn, type UseWindowSizeReturn, debounce, dispatchStorageEvent, getConnection, getDate, getOperatingSystem, getRangesSelection, getRetry, getTargetElement, isClient, isHotkeyMatch, legacyCopyToClipboard, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useFps, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMediaQuery, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };
+export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseEyeDropperReturn, type UseFaviconReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseListReturn, type UseLongPress, type UseLongPressReturn, type UseLongPressTarget, type UseMouse, type UseMouseReturn, type UseNetworkReturn, type UseOrientationReturn, type UsePaint, type UsePaintOptions, type UsePaintPencil, type UsePaintReturn, type UsePaintTarget, type UsePreferredColorSchemeReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseTimeReturn, type UseToggleReturn, type UseWindowSizeReturn, debounce, dispatchStorageEvent, getConnection, getDate, getOperatingSystem, getRangesSelection, getRetry, getTargetElement, isClient, isHotkeyMatch, legacyCopyToClipboard, throttle, useBattery, useBoolean, useBrowserLanguage, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useFps, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMediaQuery, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

package/dist/cjs/_rollupPluginBabelHelpers-Dp-teDDf.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-Dp-teDDf.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-BK7XeaSH.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-BK7XeaSH.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}