@siberiacancode/reactuse 0.0.46 → 0.0.47

package/dist/esm/utils/helpers/isPermissionAllowed.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.46 */
+/* @license @siberiacancode/reactuse v0.0.47 */
 var r=function(r){return"granted"===r||"prompt"===r};export{r as isPermissionAllowed};
 //# sourceMappingURL=isPermissionAllowed.js.map

package/dist/esm/utils/helpers/throttle.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.46 */
+/* @license @siberiacancode/reactuse v0.0.47 */
 var n=function(n,t){var o=!1;return function(){o||(n.apply(void 0,arguments),o=!0,setTimeout((function(){o=!1}),t))}};export{n as throttle};
 //# sourceMappingURL=throttle.js.map

package/dist/esm/utils/helpers/time/getDate.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.46 */
+/* @license @siberiacancode/reactuse v0.0.47 */
 var e=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:new Date,t=e.getSeconds(),n=e.getMinutes(),r=e.getHours();return{seconds:t,minutes:n,hours:r,meridiemHours:{value:r%12==0?12:r%12,type:r>=12?"pm":"am"},day:e.getDate(),month:e.getMonth()+1,year:e.getFullYear(),timestamp:e.getTime()}};export{e as getDate};
 //# sourceMappingURL=getDate.js.map

package/dist/esm/utils/types/index.js

@@ -1,2 +1,2 @@
-/* @license @siberiacancode/reactuse v0.0.46 */
+/* @license @siberiacancode/reactuse v0.0.47 */
 //# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -54,6 +54,51 @@ type UseBooleanReturn = [
  */
 declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;
 
+type Breakpoints<Breakpoint extends string = string> = Record<Breakpoint, number>;
+/** The use breakpoints strategy */
+type UseBreakpointsStrategy = 'mobile-first' | 'desktop-first';
+/** The use breakpoints return type */
+type UseBreakpointsReturn<Breakpoint extends string = string> = {
+    /** The function that checks if the current breakpoint is greater than to the given breakpoint */
+    greater: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is greater than or equal to the given breakpoint */
+    greaterOrEqual: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is smaller than to the given breakpoint */
+    smaller: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is smaller than or equal to the given breakpoint */
+    smallerOrEqual: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is between to the given breakpoints */
+    between: (a: Breakpoint, b: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is greater than to the given breakpoint */
+    isGreater: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is greater than or equal to the given breakpoint */
+    isGreaterOrEqual: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is smaller than to the given breakpoint */
+    isSmaller: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is smaller than or equal to the given breakpoint */
+    isSmallerOrEqual: (breakpoint: Breakpoint) => boolean;
+    /** The function that checks if the current breakpoint is between to the given breakpoints */
+    isInBetween: (a: Breakpoint, b: Breakpoint) => boolean;
+    /** The function that returns the current breakpoints */
+    current: () => Breakpoint[];
+    /** The function that returns the current active breakpoint */
+    active: () => Breakpoint;
+} & Record<Breakpoint, boolean>;
+/**
+ * @name useBreakpoints
+ * @description - Hook that manages breakpoints
+ * @category Browser
+ *
+ * @template {string} Breakpoint The name of the breakpoint
+ * @param {Breakpoints<Breakpoint>} breakpoints The breakpoints to use
+ * @param {UseBreakpointsStrategy} [strategy=min-width] The strategy to use for matching
+ * @returns {UseBreakpointsReturn<Breakpoint>} An object containing the current breakpoint
+ *
+ * @example
+ * const { greaterOrEqual, smallerOrEqual, current } = useBreakpoints({ mobile: 0, tablet: 640, laptop: 1024, desktop: 1280 });
+ */
+declare const useBreakpoints: <Breakpoint extends string>(breakpoints: Breakpoints<Breakpoint>, strategy?: UseBreakpointsStrategy) => UseBreakpointsReturn<Breakpoint>;
+
 /**
  * @name useBrowserLanguage
  * @description - Hook that returns the current browser language
@@ -1544,6 +1589,16 @@ type UsePreferredColorSchemeReturn = 'dark' | 'light' | 'no-preference';
  */
 declare const usePreferredColorScheme: () => UsePreferredColorSchemeReturn;
 
+/**
+ * @name usePreferredDark
+ * @description - Hook that returns if the user prefers dark mode
+ * @category Browser
+ *
+ * @example
+ * const isDark = usePreferredDark();
+ */
+declare const usePreferredDark: () => boolean;
+
 /**
  * @name usePreferredLanguages
  * @description Hook that returns a browser preferred languages from navigator
@@ -2072,10 +2127,8 @@ declare const useWindowEvent: <Event extends keyof WindowEventMap>(event: Event,
 
 /** The use window size return type */
 interface UseWindowSizeParams {
-    /** The initial window width */
-    initialWidth?: number;
-    /** The initial window height */
-    initialHeight?: number;
+    /** Whether to include the scrollbar in the window size calculation */
+    includeScrollbar?: boolean;
 }
 /**
  * @name useWindowSize
@@ -2146,4 +2199,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useBattery, useBoolean, 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, 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, usePreferredLanguages, usePrevious, useQuery, useQueue, 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, 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, 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, usePreferredDark, usePreferredLanguages, usePrevious, useQuery, useQueue, 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.46",
+  "version": "0.0.47",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

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

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

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

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