@siberiacancode/reactuse 0.0.23 → 0.0.25

package/dist/index.d.ts

@@ -45,6 +45,17 @@ type UseBooleanReturn = [
  */
 declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 
+/**
+ * @name useBrowserLanguage
+ * @description - Hook that returns the current browser language
+ *
+ * @returns {string} The current browser language
+ *
+ * @example
+ * const browserLanguage = useBrowserLanguage();
+ */
+declare const useBrowserLanguage: () => string;
+
 /** The use click outside target element type */
 type UseClickOutsideTarget = React.RefObject<Element | null> | (() => Element) | Element;
 /** The use click outside return type */
@@ -95,7 +106,7 @@ interface UseCopyToClipboardReturn {
  */
 declare const useCopyToClipboard: () => UseCopyToClipboardReturn;
 
-/** The use counter options type */
+/** The use counter options */
 interface UseCounterOptions {
     /** The min of count value */
     min?: number;
@@ -136,16 +147,15 @@ type UseCounter = {
  * @param {number} [options.min=Number.NEGATIVE_INFINITY] The min of count value
  * @param {number} [options.max=Number.POSITIVE_INFINITY] The max of count value
  * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter
- *
- * @example
- * const { count, dec, inc, reset, set } = useCounter(5);
- *
+
  * @overload
  * @param {number} [params.initialValue=0] The initial number value
  * @param {number} [params.min=Number.NEGATIVE_INFINITY] The min of count value
  * @param {number} [params.max=Number.POSITIVE_INFINITY] The max of count value
  * @returns {UseCounterReturn} An object containing the current count and functions to interact with the counter
  *
+ * @example
+ * const { count, dec, inc, reset, set } = useCounter(5);
  *
  * @example
  * const { count, dec, inc, reset, set } = useCounter({ initialValue: 5, min: 0, max: 10 });
@@ -179,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 */
@@ -235,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>>];
@@ -264,6 +305,17 @@ declare const useFavicon: (initialHref?: string) => {
     readonly set: (favicon: string) => void;
 };
 
+/**
+ * @name useFps
+ * @description - Hook that measures frames per second
+ *
+ * @returns {number} A number which determines frames per second
+ *
+ * @example
+ * const fps = useFps();
+ */
+declare const useFps: () => number;
+
 /** The use fullscreen target element type */
 type UseFullScreenTarget = React.RefObject<Element | null> | (() => Element) | Element;
 /** The use fullscreen options type */
@@ -912,6 +964,52 @@ declare const useOrientation: () => UseOrientationReturn;
  */
 declare const usePageLeave: (callback: () => void) => void;
 
+interface UsePaintPencil {
+    /** Pencil color */
+    color?: string;
+    /** Pencil width */
+    width?: number;
+    /** Pencil opacity */
+    opacity?: number;
+}
+type UsePaintOptions = UsePaintPencil;
+/** The use paint return type */
+interface UsePaintReturn {
+    pencil: UsePaintPencil & {
+        set: React.Dispatch<React.SetStateAction<UsePaintPencil>>;
+    };
+    drawing: boolean;
+}
+type UsePaintTarget = React.RefObject<HTMLCanvasElement> | (() => HTMLCanvasElement) | HTMLCanvasElement;
+declare const getTargetElement: (target: UsePaintTarget) => HTMLCanvasElement | null;
+type UsePaint = {
+    <Target extends UsePaintTarget>(target: Target, options?: UsePaintOptions): UsePaintReturn;
+    (options?: UsePaintOptions, target?: never): UsePaintReturn & {
+        ref: React.RefObject<HTMLCanvasElement>;
+    };
+};
+/**
+ * @name usePaint
+ * @description - Hook that allows you to draw in a specific area
+ *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element to be painted
+ * @param {UsePaintOptions} [options] The options to be used
+ * @returns {UsePaintReturn} An object containing the current pencil options and functions to interact with the paint
+ *
+ * @example
+ * const { pencil, drawing } = usePaint(canvasRef);
+ *
+ * @overload
+ * @param {UsePaintOptions} [options] The options to be used
+ * @returns {UsePaintReturn & { ref: React.RefObject<HTMLCanvasElement> }} An object containing the current pencil options and functions to interact with the paint
+ *
+ * @example
+ * const { ref, pencil, drawing } = usePaint();
+ */
+declare const usePaint: UsePaint;
+
 /** The use preferred color scheme return type */
 type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
 /**
@@ -1204,6 +1302,30 @@ interface UseTextSelectionReturn {
  */
 declare const useTextSelection: () => UseTextSelectionReturn;
 
+interface UseTimeReturn {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    meridiemHours: {
+        value: number;
+        type: string;
+    };
+    day: number;
+    month: number;
+    year: number;
+    timestamp: number;
+}
+/**
+ * @name useTime
+ * @description - Hook that gives you current time in different values
+ *
+ * @returns {UseTimeReturn} An object containing the current time
+ *
+ * @example
+ * const { seconds, minutes, hours, meridiemHours, day, month, year, timestamp } = useTime();
+ */
+declare const useTime: () => UseTimeReturn;
+
 /** The use timeout return type */
 interface UseTimeoutReturn {
     /**  Timeout is ready state value */
@@ -1213,7 +1335,7 @@ interface UseTimeoutReturn {
 }
 /**
  * @name useTimeout
- * @description Hook that executes a callback function after a specified delay
+ * @description - Hook that executes a callback function after a specified delay
  *
  * @param {() => void} callback The function to be executed after the timeout
  * @param {number} delay The delay in milliseconds before the timeout executes the callback function
@@ -1306,4 +1428,18 @@ declare const isClient: boolean;
 
 declare const throttle: <Params extends any[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
-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 UsePreferredColorSchemeReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseToggleReturn, type UseWindowSizeReturn, debounce, dispatchStorageEvent, getConnection, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, legacyCopyToClipboard, throttle, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, 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, usePreferredColorScheme, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTextSelection, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };
+declare const getDate: (now?: Date) => {
+    seconds: number;
+    minutes: number;
+    hours: number;
+    meridiemHours: {
+        value: number;
+        type: string;
+    };
+    day: number;
+    month: number;
+    year: number;
+    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 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.23",
+  "version": "0.0.25",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

package/dist/cjs/_rollupPluginBabelHelpers-OXydtwwP.js.map

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

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

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