@siberiacancode/reactuse 0.0.58 → 0.0.59

package/dist/index.d.ts

@@ -74,6 +74,7 @@ type UseBooleanReturn = [
  */
 declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 
+/** The breakpoints type */
 type Breakpoints<Breakpoint extends string = string> = Record<Breakpoint, number>;
 /** The use breakpoints strategy */
 type UseBreakpointsStrategy = 'mobile-first' | 'desktop-first';
@@ -298,14 +299,22 @@ declare const useDefault: <Value>(initialValue: Value | (() => Value), defaultVa
  */
 declare const useDidUpdate: (effect: EffectCallback, deps?: DependencyList) => void;
 
+/** The use disclosure options type */
 interface UseDisclosureOptions {
+    /** The callback function to be invoked on open */
     onOpen?: () => void;
+    /** The callback function to be invoked on close */
     onClose?: () => void;
 }
+/** The use disclosure return type */
 interface UseDisclosureReturn {
+    /** The opened value */
     opened: boolean;
+    /** Function to open the modal */
     open: () => void;
+    /** Function to close the modal */
     close: () => void;
+    /** Function to toggle the modal */
     toggle: () => void;
 }
 /**
@@ -411,8 +420,11 @@ declare global {
 }
 /** The color selection return type */
 interface UseEyeDropperReturn {
+    /** The eye dropper supported status */
     supported: boolean;
+    /** The eye dropper value */
     value?: string;
+    /** The eye dropper open method */
     open: (colorSelectionOptions?: ColorSelectionOptions) => Promise<ColorSelectionResult>;
 }
 /**
@@ -650,6 +662,27 @@ type UseFullScreen = {
  */
 declare const useFullscreen: UseFullScreen;
 
+declare global {
+    interface Gamepad {
+        hapticActuators?: GamepadHapticActuator[];
+    }
+}
+/**
+ * @name useGamepad
+ * @description - Hook for getting information about gamepad
+ * @category Browser
+ *
+ * @returns {UseGamepadStateReturn} An object containing the gamepad information
+ *
+ * @example
+ * const { supported, gamepads, active } = useGamepad();
+ */
+declare const useGamepad: () => {
+    active: boolean;
+    supported: boolean;
+    gamepads: Gamepad[];
+};
+
 /** The use geolocation return type */
 interface UseGeolocationReturn {
     /** The loading state */
@@ -831,6 +864,10 @@ interface UseQueryOptions<QueryData, Data> {
     refetchInterval?: number;
     enabled?: boolean;
 }
+interface UseQueryCallbackParams {
+    signal: AbortSignal;
+    keys: DependencyList;
+}
 interface UseQueryReturn<Data> {
     data?: Data;
     isLoading: boolean;
@@ -839,6 +876,8 @@ interface UseQueryReturn<Data> {
     error?: Error;
     refetch: () => void;
     isRefetching: boolean;
+    abort: AbortController['abort'];
+    isAborted: boolean;
 }
 /**
  * @name useQuery
@@ -860,7 +899,7 @@ interface UseQueryReturn<Data> {
  * @example
  * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useQuery(() => fetch('url'));
  */
-declare const useQuery: <QueryData, Data = QueryData>(callback: () => Promise<QueryData>, options?: UseQueryOptions<QueryData, Data>) => UseQueryReturn<Data>;
+declare const useQuery: <QueryData, Data = QueryData>(callback: (params: UseQueryCallbackParams) => Promise<QueryData>, options?: UseQueryOptions<QueryData, Data>) => UseQueryReturn<Data>;
 
 /** The use image options */
 interface UseImageOptions {
@@ -1351,8 +1390,11 @@ declare global {
         };
     }
 }
+/** The use memory return type */
 interface UseMemoryReturn {
+    /** The memory supported status */
     supported: boolean;
+    /** The current memory usage */
     value: Performance['memory'];
 }
 /**
@@ -1493,6 +1535,75 @@ interface UseNetworkReturn {
  */
 declare const useNetwork: () => UseNetworkReturn;
 
+/** The use offset pagination return type */
+interface UseOffsetPaginationOptions {
+    /** The total number of items */
+    total?: number;
+    /** The number of items per page */
+    pageSize?: number;
+    /** The initial page number */
+    initialPage?: number;
+    /** The callback function to be invoked when page changes */
+    onPageChange?: ({ page, pageSize }: {
+        page: number;
+        pageSize: number;
+    }) => void;
+    /** The callback function to be invoked when page size changes */
+    onPageSizeChange?: ({ page, pageSize }: {
+        page: number;
+        pageSize: number;
+    }) => void;
+    /** The callback function to be invoked when page count changes */
+    onPageCountChange?: ({ page, pageSize }: {
+        page: number;
+        pageSize: number;
+    }) => void;
+}
+/** The use offset pagination return type */
+interface UseOffsetPaginationReturn {
+    /** The current page number */
+    page: number;
+    /** The number of items per page */
+    currentPageSize: number;
+    /** The total number of pages */
+    pageCount: number;
+    /** Whether the current page is the first page */
+    isFirstPage: boolean;
+    /** Whether the current page is the last page */
+    isLastPage: boolean;
+    /** The callback function to go to the previous page */
+    prev: () => void;
+    /** The callback function to go to the next page */
+    next: () => void;
+    /** The callback function to set the current page */
+    set: (page: number) => void;
+}
+/**
+ * @name useOffsetPagination
+ * @description - Hook that defines the logic when pagination
+ * @category Utilities
+ *
+ * @param {UseOffsetPaginationOptions} options - The options for the hook
+ * @param {number} [options.total] - The total number of items
+ * @param {number} [options.pageSize] - The number of items per page
+ * @param {number} [options.initialPage] - The current page
+ * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageChange] - The callback function to be invoked when page changes
+ * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageCountChange] - The callback function to be invoked when page count changes
+ * @param {({ page, pageSize }: { page: number; pageSize: number }) => void} [options.onPageSizeChange] - The callback function to be invoked when page size changes
+ * @returns {UseOffsetPaginationReturn} - The state of the hook
+ *
+ * @example
+ * const { currentPage, currentPageSize, pageCount, isFirstPage, isLastPage, prev, next } = useOffsetPagination({
+ *  total: 100,
+ *  pageSize: 10,
+ *  page: 1,
+ *  onPageChange: (page) => {},
+ *  onPageCountChange: (pageCount) => {},
+ *  onPageSizeChange: (pageSize) => {}
+ * });
+ */
+declare const useOffsetPagination: ({ total, pageSize, initialPage, onPageChange, onPageCountChange, onPageSizeChange }?: UseOffsetPaginationOptions) => UseOffsetPaginationReturn;
+
 /**
  * @name useOnline
  * @description - Hook that manages if the user is online
@@ -1652,6 +1763,7 @@ type UsePaint = {
  */
 declare const usePaint: UsePaint;
 
+/** The permission name */
 type UsePermissionName = PermissionName | 'accelerometer' | 'accessibility-events' | 'ambient-light-sensor' | 'background-sync' | 'camera' | 'clipboard-read' | 'clipboard-write' | 'gyroscope' | 'magnetometer' | 'microphone' | 'notifications' | 'payment-handler' | 'persistent-storage' | 'push' | 'speaker';
 /**
  *  @name usePermission
@@ -2376,4 +2488,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };
+export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGamepad, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOffsetPagination, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRaf, useRafValue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };

package/package.json

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

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

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

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

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