@reactuses/core 6.0.7 → 6.1.0-beta.1

package/README.md

@@ -1,31 +1,20 @@
-<div align = "center">
-   <h1 align = "center">
-    reactuse
-  </h1>
-</div>
+# reactuse
 
 <p align="center">
-  <a href="https://bundlephobia.com/result?p=@reactuses/core">
-    <img alt="Bundlephobia" src="https://img.shields.io/bundlephobia/minzip/@reactuses/core?style=for-the-badge&labelColor=24292e">
-  </a>
-  <a aria-label="Types" href="https://www.npmjs.com/package/@reactuses/core">
-    <img alt="Types" src="https://img.shields.io/npm/types/react-use-system-color-mode?style=for-the-badge&labelColor=24292e">
-  </a>
-  <a aria-label="NPM version" href="https://www.npmjs.com/package/@reactuses/core">
-    <img alt="NPM Version" src="https://img.shields.io/npm/v/@reactuses/core?style=for-the-badge&labelColor=24292e">
-  </a>
-  <a aria-label="License" href="https://jaredlunde.mit-license.org/">
-    <img alt="UnLicense" src="https://img.shields.io/npm/l/@reactuses/core?style=for-the-badge&labelColor=24292e">
-  </a>
+  <img alt="NPM Version" src="https://img.shields.io/npm/v/@reactuses/core?style=for-the-badge&labelColor=24292e">
+  <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@reactuses/core?color=50a36f&label=&style=for-the-badge&labelColor=24292e">
+  <img alt="UnLicense" src="https://img.shields.io/npm/l/@reactuses/core?style=for-the-badge&labelColor=24292e">
+  <img alt="Tree Shaking Friendly" src="https://img.shields.io/badge/Tree%20Shaking-Friendly-brightgreen?style=for-the-badge&labelColor=24292e">
+  <img alt="TypeScript Support" src="https://img.shields.io/badge/TypeScript-Support-blue?style=for-the-badge&labelColor=24292e">
 </p>
 
-<pre align="center">npm i @reactuses/core</pre>
+```bash
+npm i @reactuses/core
+```
 
-<p align="center">
-Collection of essential React Hooks Utilities.
-</p>
+**Collection of essential React Hooks Utilities.**
 
-<hr>
+---
 
 ## MCP Support
 
@@ -62,26 +51,26 @@ function Demo() {
 
 Refer to [documentations](https://reactuse.com/) for more details.
 
-<hr>
+---
 
 ## Who's Using This
 
 [![PDD](https://img.shields.io/badge/PDD-E_Commerce-orange?style=for-the-badge)](https://www.pinduoduo.com/)
 [![Ctrip](https://img.shields.io/badge/Ctrip-Travel-blue?style=for-the-badge)](https://www.ctrip.com/)
 
-<hr>
+---
 
 ## Documentation & Live Examples
 
 - [Documentation](https://reactuse.com/)
 
-<hr/>
+---
 
 ## Feedback
 
 You can submit an [issue](https://github.com/childrentime/reactuse/issues) or provide feedback on [Discord](https://discord.gg/HMsq6cFkKp).
 
-<hr/>
+---
 
 ## Contribute
 
@@ -91,7 +80,7 @@ See the [**Contributing Guide**](https://github.com/childrentime/reactuse/blob/m
 
 See the [**ChangeLog**](https://github.com/childrentime/reactuse/blob/main/packages/core/changelog.md)
 
-<hr/>
+---
 
 ## Thanks
 
@@ -101,10 +90,10 @@ This project is heavily inspired by the following awesome projects.
 - [ahooks](https://github.com/alibaba/hooks)
 - [vueuse](https://github.com/vueuse/vueuse)
 
-<hr/>
+---
 
 ## Sponsor Me
 
 If my work has helped you, consider buying me a cup of coffee. Thank you very much🥰!.
 
-[Buy me a coffee](https://www.buymeacoffee.com/lianwenwu)
+[Buy me a coffee](https://www.buymeacoffee.com/lianwenwu)

package/dist/index.cjs

@@ -713,49 +713,132 @@ function useStorage(key, defaultValue, getStorage = ()=>isBrowser ? sessionStora
     ];
 }
 
-function value() {
-    return window.matchMedia('(prefers-color-scheme: dark)').matches;
-}
-const useDarkMode = (options)=>{
-    const { selector = 'html', attribute = 'class', classNameDark = '', classNameLight = '', storageKey = 'reactuses-color-scheme', storage = ()=>isBrowser ? localStorage : undefined, defaultValue = false } = options;
-    const [dark, setDark] = useStorage(storageKey, defaultValue, storage, {
-        mountStorageValue: value
+const useColorMode = (options)=>{
+    const { selector = 'html', attribute = 'class', modes, defaultValue, storageKey = 'reactuses-color-mode', storage = ()=>isBrowser ? localStorage : undefined, initialValueDetector, modeClassNames = {} } = options;
+    const initialValueDetectorRef = useLatest(initialValueDetector);
+    // Validate modes array
+    if (!modes || modes.length === 0) {
+        throw new Error('useColorMode: modes array cannot be empty');
+    }
+    // Get initial value from detector or use first mode as fallback
+    const getInitialValue = React.useCallback(()=>{
+        if (initialValueDetectorRef.current) {
+            const initialValueDetector = initialValueDetectorRef.current;
+            try {
+                const detectedValue = initialValueDetector();
+                return modes.includes(detectedValue) ? detectedValue : modes[0];
+            } catch (e) {
+                return modes[0];
+            }
+        }
+        return defaultValue && modes.includes(defaultValue) ? defaultValue : modes[0];
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [
+        defaultValue,
+        JSON.stringify(modes)
+    ]);
+    const [colorMode, setColorMode] = useStorage(storageKey, defaultValue, storage, {
+        mountStorageValue: getInitialValue
     });
-    React.useEffect(()=>{
+    // Apply color mode to DOM element
+    useDeepCompareEffect(()=>{
         var _window;
+        if (!colorMode) return;
         const element = (_window = window) == null ? void 0 : _window.document.querySelector(selector);
-        if (!element) {
-            return;
-        }
+        if (!element) return;
+        // Remove all existing mode classes/attributes
+        modes.forEach((mode)=>{
+            const className = modeClassNames[mode] || mode;
+            if (attribute === 'class') {
+                element.classList.remove(className);
+            } else {
+                element.removeAttribute(attribute);
+            }
+        });
+        // Apply current mode class/attribute
+        const currentClassName = modeClassNames[colorMode] || colorMode;
         if (attribute === 'class') {
-            dark && classNameDark && element.classList.add(classNameDark);
-            !dark && classNameLight && element.classList.add(classNameLight);
+            element.classList.add(currentClassName);
         } else {
-            dark && classNameDark && element.setAttribute(attribute, classNameDark);
-            !dark && classNameLight && element.setAttribute(attribute, classNameLight);
+            element.setAttribute(attribute, currentClassName);
         }
         return ()=>{
-            if (!element) {
-                return;
-            }
+            // Cleanup: remove current mode class/attribute
             if (attribute === 'class') {
-                dark && classNameDark && element.classList.remove(classNameDark);
-                !dark && classNameLight && element.classList.remove(classNameLight);
+                element.classList.remove(currentClassName);
             } else {
-                dark && classNameDark && element.removeAttribute(attribute);
-                !dark && classNameLight && element.removeAttribute(attribute);
+                element.removeAttribute(attribute);
             }
         };
     }, [
+        colorMode,
+        selector,
+        attribute,
+        modes,
+        modeClassNames
+    ]);
+    const cycle = useEvent(()=>{
+        if (!colorMode) return;
+        const currentIndex = modes.indexOf(colorMode);
+        const nextIndex = (currentIndex + 1) % modes.length;
+        setColorMode(modes[nextIndex]);
+    });
+    return [
+        colorMode,
+        setColorMode,
+        cycle
+    ];
+};
+
+function getSystemPreference() {
+    return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+}
+const useDarkMode = (options)=>{
+    const { selector = 'html', attribute = 'class', classNameDark = '', classNameLight = '', storageKey = 'reactuses-color-scheme', storage = ()=>isBrowser ? localStorage : undefined, defaultValue = false } = options;
+    // Convert boolean-based options to string-based options for useColorMode
+    const [colorMode, setColorMode] = useColorMode({
+        selector,
         attribute,
-        classNameDark,
-        classNameLight,
+        modes: [
+            'light',
+            'dark'
+        ],
+        defaultValue: defaultValue ? 'dark' : 'light',
+        storageKey,
+        storage,
+        initialValueDetector: getSystemPreference,
+        modeClassNames: {
+            dark: classNameDark,
+            light: classNameLight
+        }
+    });
+    // Convert string mode back to boolean
+    const dark = colorMode === 'dark';
+    // Toggle function that switches between dark and light
+    const toggle = React.useCallback(()=>{
+        setColorMode(dark ? 'light' : 'dark');
+    }, [
         dark,
-        selector
+        setColorMode
+    ]);
+    // Set function that accepts boolean value
+    const setDark = React.useCallback((value)=>{
+        if (typeof value === 'function') {
+            const currentDark = colorMode === 'dark';
+            const newDark = value(currentDark);
+            if (newDark !== null) {
+                setColorMode(newDark ? 'dark' : 'light');
+            }
+        } else if (value !== null) {
+            setColorMode(value ? 'dark' : 'light');
+        }
+    }, [
+        colorMode,
+        setColorMode
     ]);
     return [
         dark,
-        ()=>setDark((dark)=>!dark),
+        toggle,
         setDark
     ];
 };
@@ -3725,6 +3808,29 @@ const useBroadcastChannel = (options)=>{
     };
 };
 
+const useBoolean = (initialValue = false)=>{
+    const [value, setValue] = React.useState(initialValue);
+    const setTrue = useEvent(()=>{
+        setValue(true);
+    });
+    const setFalse = useEvent(()=>{
+        setValue(false);
+    });
+    const toggle = useEvent(()=>{
+        setValue((prev)=>!prev);
+    });
+    const handleSetValue = useEvent((newValue)=>{
+        setValue(newValue);
+    });
+    return {
+        value,
+        setValue: handleSetValue,
+        setTrue,
+        setFalse,
+        toggle
+    };
+};
+
 const useDevicePixelRatio = ()=>{
     const [pixelRatio, setPixelRatio] = React.useState(1);
     const observe = React.useCallback(()=>{
@@ -4036,17 +4142,83 @@ const useFetchEventSource = (url, options = {})=>{
     };
 };
 
+const useMap = (initialValue)=>{
+    // avoid exec init code every render
+    const initFunc = ()=>{
+        if (typeof initialValue === 'function') {
+            const result = initialValue();
+            return result instanceof Map ? new Map(result) : new Map(result);
+        }
+        if (initialValue instanceof Map) {
+            return new Map(initialValue);
+        }
+        if (Array.isArray(initialValue)) {
+            return new Map(initialValue);
+        }
+        return new Map();
+    };
+    const [map, setMap] = React.useState(initFunc);
+    const set = useEvent((key, value)=>{
+        setMap((prevMap)=>{
+            const newMap = new Map(prevMap);
+            newMap.set(key, value);
+            return newMap;
+        });
+    });
+    const get = React.useCallback((key)=>{
+        return map.get(key);
+    }, [
+        map
+    ]);
+    const remove = useEvent((key)=>{
+        const hasKey = map.has(key);
+        if (hasKey) {
+            setMap((prevMap)=>{
+                const newMap = new Map(prevMap);
+                newMap.delete(key);
+                return newMap;
+            });
+        }
+        return hasKey;
+    });
+    const has = React.useCallback((key)=>{
+        return map.has(key);
+    }, [
+        map
+    ]);
+    const clear = useEvent(()=>{
+        setMap(new Map());
+    });
+    const reset = useEvent(()=>{
+        setMap(initFunc());
+    });
+    return {
+        map,
+        set,
+        get,
+        remove,
+        has,
+        clear,
+        reset,
+        size: map.size
+    };
+};
+
 exports.assignRef = assignRef;
 exports.defaultOptions = defaultOptions;
 exports.mergeRefs = mergeRefs;
 exports.use = use;
 exports.useActiveElement = useActiveElement;
 exports.useAsyncEffect = useAsyncEffect;
+exports.useBoolean = useBoolean;
 exports.useBroadcastChannel = useBroadcastChannel;
+exports.useClickAway = useClickOutside;
 exports.useClickOutside = useClickOutside;
 exports.useClipboard = useClipboard;
+exports.useColorMode = useColorMode;
 exports.useControlled = useControlled;
 exports.useCookie = useCookie;
+exports.useCopyToClipboard = useClipboard;
 exports.useCountDown = useCountDown;
 exports.useCounter = useCounter;
 exports.useCssVar = useCssVar;
@@ -4090,6 +4262,7 @@ exports.useLatest = useLatest;
 exports.useLocalStorage = useLocalStorage;
 exports.useLocationSelector = useLocationSelector;
 exports.useLongPress = useLongPress;
+exports.useMap = useMap;
 exports.useMeasure = useMeasure;
 exports.useMediaDevices = useMediaDevices;
 exports.useMediaQuery = useMediaQuery;

package/dist/index.d.cts

@@ -2953,6 +2953,36 @@ interface UseBroadcastChannelReturn<D, P> {
 
 declare const useBroadcastChannel: UseBroadcastChannel;
 
+/**
+ * @title useBoolean
+ * @returns_en An object with the following properties:
+ * - value: The current boolean value.
+ * - setValue: A function to set the boolean value directly.
+ * - setTrue: A function to set the value to true.
+ * - setFalse: A function to set the value to false.
+ * - toggle: A function to toggle the boolean value.
+ * @returns 包含以下属性的对象：
+ * - value: 当前的布尔值。
+ * - setValue: 直接设置布尔值的函数。
+ * - setTrue: 将值设置为 true 的函数。
+ * - setFalse: 将值设置为 false 的函数。
+ * - toggle: 切换布尔值的函数。
+ */
+type UseBoolean = (
+/**
+ * @zh 初始值，默认为 false
+ * @en The initial boolean value. Defaults to false.
+ */
+initialValue?: boolean) => {
+    readonly value: boolean;
+    readonly setValue: (value: boolean) => void;
+    readonly setTrue: () => void;
+    readonly setFalse: () => void;
+    readonly toggle: () => void;
+};
+
+declare const useBoolean: UseBoolean;
+
 /**
  * @title UseDevicePixelRatio
  */
@@ -3189,6 +3219,113 @@ options?: UseFetchEventSourceOptions) => UseFetchEventSourceReturn;
 
 declare const useFetchEventSource: UseFetchEventSource;
 
+/**
+ * @title useMap
+ * @returns_en An object with the following properties:
+ * - map: The current Map instance.
+ * - set: A function to set a key-value pair in the map.
+ * - get: A function to get a value by key from the map.
+ * - remove: A function to remove a key from the map and return whether it existed.
+ * - has: A function to check if a key exists in the map.
+ * - clear: A function to clear all entries from the map.
+ * - reset: A function to reset the map to its initial state.
+ * - size: The current size of the map.
+ * @returns 包含以下属性的对象：
+ * - map: 当前的 Map 实例。
+ * - set: 在 map 中设置键值对的函数。
+ * - get: 通过键从 map 中获取值的函数。
+ * - remove: 从 map 中删除键并返回是否存在的函数。
+ * - has: 检查键是否存在于 map 中的函数。
+ * - clear: 清除 map 中所有条目的函数。
+ * - reset: 将 map 重置为其初始状态的函数。
+ * - size: map 的当前大小。
+ */
+type UseMap<K = any, V = any> = (
+/**
+ * @zh 初始值，可以为 Map 实例、数组或者一个初始化的函数
+ * @en The initial value of the map. It can be a Map instance, an array of key-value pairs, or a function that returns initial entries.
+ */
+initialValue?: Map<K, V> | readonly (readonly [K, V])[] | (() => Map<K, V> | readonly (readonly [K, V])[])) => {
+    readonly map: Map<K, V>;
+    readonly set: (key: K, value: V) => void;
+    readonly get: (key: K) => V | undefined;
+    readonly remove: (key: K) => boolean;
+    readonly has: (key: K) => boolean;
+    readonly clear: () => void;
+    readonly reset: () => void;
+    readonly size: number;
+};
+
+declare const useMap: UseMap;
+
+/**
+ * @title UseColorModeOptions
+ */
+interface UseColorModeOptions<T extends string = string> {
+    /**
+     * @en CSS Selector for the target element applying to
+     * @zh 适用于目标元素的 CSS 选择器
+     * @defaultValue 'html'
+     */
+    selector?: string;
+    /**
+     * @en HTML attribute applying the target element
+     * @zh 应用到目标元素的 html 属性
+     * @defaultValue 'class'
+     */
+    attribute?: string;
+    /**
+     * @en Available color modes
+     * @zh 可用的颜色模式
+     */
+    modes: T[];
+    /**
+     * @en Default color mode
+     * @zh 默认颜色模式
+     */
+    defaultValue?: T;
+    /**
+     * @en Key to persist the data into localStorage/sessionStorage.
+     * @zh 将数据持久保存到 localStorage/sessionStorage 的键值
+     * @defaultValue 'reactuses-color-mode'
+     */
+    storageKey?: string;
+    /**
+     * @en Storage object, can be localStorage or sessionStorage
+     * @zh 存储对象，可以是localStorage或sessionStorage
+     * @defaultValue `localStorage`
+     */
+    storage?: () => Storage | undefined;
+    /**
+     * @en Function to get initial color mode from system preference
+     * @zh 从系统偏好获取初始颜色模式的函数
+     */
+    initialValueDetector?: () => T;
+    /**
+     * @en Mapping of color modes to their corresponding class names or attribute values
+     * @zh 颜色模式到对应类名或属性值的映射
+     */
+    modeClassNames?: Partial<Record<T, string>>;
+}
+/**
+ * @title useColorMode
+ * @returns_en A tuple with the following elements:
+ * - The current color mode value.
+ * - A function to set the color mode.
+ * - A function to cycle through available modes.
+ * @returns 包含以下元素的元组：
+ * - 当前颜色模式值。
+ * - 设置颜色模式的函数。
+ * - 循环切换可用模式的函数。
+ */
+type UseColorMode<T extends string = string> = (options: UseColorModeOptions<T>) => readonly [
+    T | null,
+    React.Dispatch<React.SetStateAction<T | null>>,
+    () => void
+];
+
+declare const useColorMode: UseColorMode;
+
 /**
  * @title useDocumentVisiblity
  * @returns_en document visibility
@@ -3596,5 +3733,5 @@ type Use = <T>(
  */
 usable: Usable<T>) => T;
 
-export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBroadcastChannel, useClickOutside, useClipboard, useControlled, useCookie, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
-export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };
+export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBoolean, useBroadcastChannel, useClickOutside as useClickAway, useClickOutside, useClipboard, useColorMode, useControlled, useCookie, useClipboard as useCopyToClipboard, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMap, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
+export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBoolean, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseColorMode, UseColorModeOptions, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMap, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };

package/dist/index.d.mts

@@ -2953,6 +2953,36 @@ interface UseBroadcastChannelReturn<D, P> {
 
 declare const useBroadcastChannel: UseBroadcastChannel;
 
+/**
+ * @title useBoolean
+ * @returns_en An object with the following properties:
+ * - value: The current boolean value.
+ * - setValue: A function to set the boolean value directly.
+ * - setTrue: A function to set the value to true.
+ * - setFalse: A function to set the value to false.
+ * - toggle: A function to toggle the boolean value.
+ * @returns 包含以下属性的对象：
+ * - value: 当前的布尔值。
+ * - setValue: 直接设置布尔值的函数。
+ * - setTrue: 将值设置为 true 的函数。
+ * - setFalse: 将值设置为 false 的函数。
+ * - toggle: 切换布尔值的函数。
+ */
+type UseBoolean = (
+/**
+ * @zh 初始值，默认为 false
+ * @en The initial boolean value. Defaults to false.
+ */
+initialValue?: boolean) => {
+    readonly value: boolean;
+    readonly setValue: (value: boolean) => void;
+    readonly setTrue: () => void;
+    readonly setFalse: () => void;
+    readonly toggle: () => void;
+};
+
+declare const useBoolean: UseBoolean;
+
 /**
  * @title UseDevicePixelRatio
  */
@@ -3189,6 +3219,113 @@ options?: UseFetchEventSourceOptions) => UseFetchEventSourceReturn;
 
 declare const useFetchEventSource: UseFetchEventSource;
 
+/**
+ * @title useMap
+ * @returns_en An object with the following properties:
+ * - map: The current Map instance.
+ * - set: A function to set a key-value pair in the map.
+ * - get: A function to get a value by key from the map.
+ * - remove: A function to remove a key from the map and return whether it existed.
+ * - has: A function to check if a key exists in the map.
+ * - clear: A function to clear all entries from the map.
+ * - reset: A function to reset the map to its initial state.
+ * - size: The current size of the map.
+ * @returns 包含以下属性的对象：
+ * - map: 当前的 Map 实例。
+ * - set: 在 map 中设置键值对的函数。
+ * - get: 通过键从 map 中获取值的函数。
+ * - remove: 从 map 中删除键并返回是否存在的函数。
+ * - has: 检查键是否存在于 map 中的函数。
+ * - clear: 清除 map 中所有条目的函数。
+ * - reset: 将 map 重置为其初始状态的函数。
+ * - size: map 的当前大小。
+ */
+type UseMap<K = any, V = any> = (
+/**
+ * @zh 初始值，可以为 Map 实例、数组或者一个初始化的函数
+ * @en The initial value of the map. It can be a Map instance, an array of key-value pairs, or a function that returns initial entries.
+ */
+initialValue?: Map<K, V> | readonly (readonly [K, V])[] | (() => Map<K, V> | readonly (readonly [K, V])[])) => {
+    readonly map: Map<K, V>;
+    readonly set: (key: K, value: V) => void;
+    readonly get: (key: K) => V | undefined;
+    readonly remove: (key: K) => boolean;
+    readonly has: (key: K) => boolean;
+    readonly clear: () => void;
+    readonly reset: () => void;
+    readonly size: number;
+};
+
+declare const useMap: UseMap;
+
+/**
+ * @title UseColorModeOptions
+ */
+interface UseColorModeOptions<T extends string = string> {
+    /**
+     * @en CSS Selector for the target element applying to
+     * @zh 适用于目标元素的 CSS 选择器
+     * @defaultValue 'html'
+     */
+    selector?: string;
+    /**
+     * @en HTML attribute applying the target element
+     * @zh 应用到目标元素的 html 属性
+     * @defaultValue 'class'
+     */
+    attribute?: string;
+    /**
+     * @en Available color modes
+     * @zh 可用的颜色模式
+     */
+    modes: T[];
+    /**
+     * @en Default color mode
+     * @zh 默认颜色模式
+     */
+    defaultValue?: T;
+    /**
+     * @en Key to persist the data into localStorage/sessionStorage.
+     * @zh 将数据持久保存到 localStorage/sessionStorage 的键值
+     * @defaultValue 'reactuses-color-mode'
+     */
+    storageKey?: string;
+    /**
+     * @en Storage object, can be localStorage or sessionStorage
+     * @zh 存储对象，可以是localStorage或sessionStorage
+     * @defaultValue `localStorage`
+     */
+    storage?: () => Storage | undefined;
+    /**
+     * @en Function to get initial color mode from system preference
+     * @zh 从系统偏好获取初始颜色模式的函数
+     */
+    initialValueDetector?: () => T;
+    /**
+     * @en Mapping of color modes to their corresponding class names or attribute values
+     * @zh 颜色模式到对应类名或属性值的映射
+     */
+    modeClassNames?: Partial<Record<T, string>>;
+}
+/**
+ * @title useColorMode
+ * @returns_en A tuple with the following elements:
+ * - The current color mode value.
+ * - A function to set the color mode.
+ * - A function to cycle through available modes.
+ * @returns 包含以下元素的元组：
+ * - 当前颜色模式值。
+ * - 设置颜色模式的函数。
+ * - 循环切换可用模式的函数。
+ */
+type UseColorMode<T extends string = string> = (options: UseColorModeOptions<T>) => readonly [
+    T | null,
+    React.Dispatch<React.SetStateAction<T | null>>,
+    () => void
+];
+
+declare const useColorMode: UseColorMode;
+
 /**
  * @title useDocumentVisiblity
  * @returns_en document visibility
@@ -3596,5 +3733,5 @@ type Use = <T>(
  */
 usable: Usable<T>) => T;
 
-export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBroadcastChannel, useClickOutside, useClipboard, useControlled, useCookie, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
-export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };
+export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBoolean, useBroadcastChannel, useClickOutside as useClickAway, useClickOutside, useClipboard, useColorMode, useControlled, useCookie, useClipboard as useCopyToClipboard, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMap, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
+export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBoolean, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseColorMode, UseColorModeOptions, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMap, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };

package/dist/index.d.ts

@@ -2953,6 +2953,36 @@ interface UseBroadcastChannelReturn<D, P> {
 
 declare const useBroadcastChannel: UseBroadcastChannel;
 
+/**
+ * @title useBoolean
+ * @returns_en An object with the following properties:
+ * - value: The current boolean value.
+ * - setValue: A function to set the boolean value directly.
+ * - setTrue: A function to set the value to true.
+ * - setFalse: A function to set the value to false.
+ * - toggle: A function to toggle the boolean value.
+ * @returns 包含以下属性的对象：
+ * - value: 当前的布尔值。
+ * - setValue: 直接设置布尔值的函数。
+ * - setTrue: 将值设置为 true 的函数。
+ * - setFalse: 将值设置为 false 的函数。
+ * - toggle: 切换布尔值的函数。
+ */
+type UseBoolean = (
+/**
+ * @zh 初始值，默认为 false
+ * @en The initial boolean value. Defaults to false.
+ */
+initialValue?: boolean) => {
+    readonly value: boolean;
+    readonly setValue: (value: boolean) => void;
+    readonly setTrue: () => void;
+    readonly setFalse: () => void;
+    readonly toggle: () => void;
+};
+
+declare const useBoolean: UseBoolean;
+
 /**
  * @title UseDevicePixelRatio
  */
@@ -3189,6 +3219,113 @@ options?: UseFetchEventSourceOptions) => UseFetchEventSourceReturn;
 
 declare const useFetchEventSource: UseFetchEventSource;
 
+/**
+ * @title useMap
+ * @returns_en An object with the following properties:
+ * - map: The current Map instance.
+ * - set: A function to set a key-value pair in the map.
+ * - get: A function to get a value by key from the map.
+ * - remove: A function to remove a key from the map and return whether it existed.
+ * - has: A function to check if a key exists in the map.
+ * - clear: A function to clear all entries from the map.
+ * - reset: A function to reset the map to its initial state.
+ * - size: The current size of the map.
+ * @returns 包含以下属性的对象：
+ * - map: 当前的 Map 实例。
+ * - set: 在 map 中设置键值对的函数。
+ * - get: 通过键从 map 中获取值的函数。
+ * - remove: 从 map 中删除键并返回是否存在的函数。
+ * - has: 检查键是否存在于 map 中的函数。
+ * - clear: 清除 map 中所有条目的函数。
+ * - reset: 将 map 重置为其初始状态的函数。
+ * - size: map 的当前大小。
+ */
+type UseMap<K = any, V = any> = (
+/**
+ * @zh 初始值，可以为 Map 实例、数组或者一个初始化的函数
+ * @en The initial value of the map. It can be a Map instance, an array of key-value pairs, or a function that returns initial entries.
+ */
+initialValue?: Map<K, V> | readonly (readonly [K, V])[] | (() => Map<K, V> | readonly (readonly [K, V])[])) => {
+    readonly map: Map<K, V>;
+    readonly set: (key: K, value: V) => void;
+    readonly get: (key: K) => V | undefined;
+    readonly remove: (key: K) => boolean;
+    readonly has: (key: K) => boolean;
+    readonly clear: () => void;
+    readonly reset: () => void;
+    readonly size: number;
+};
+
+declare const useMap: UseMap;
+
+/**
+ * @title UseColorModeOptions
+ */
+interface UseColorModeOptions<T extends string = string> {
+    /**
+     * @en CSS Selector for the target element applying to
+     * @zh 适用于目标元素的 CSS 选择器
+     * @defaultValue 'html'
+     */
+    selector?: string;
+    /**
+     * @en HTML attribute applying the target element
+     * @zh 应用到目标元素的 html 属性
+     * @defaultValue 'class'
+     */
+    attribute?: string;
+    /**
+     * @en Available color modes
+     * @zh 可用的颜色模式
+     */
+    modes: T[];
+    /**
+     * @en Default color mode
+     * @zh 默认颜色模式
+     */
+    defaultValue?: T;
+    /**
+     * @en Key to persist the data into localStorage/sessionStorage.
+     * @zh 将数据持久保存到 localStorage/sessionStorage 的键值
+     * @defaultValue 'reactuses-color-mode'
+     */
+    storageKey?: string;
+    /**
+     * @en Storage object, can be localStorage or sessionStorage
+     * @zh 存储对象，可以是localStorage或sessionStorage
+     * @defaultValue `localStorage`
+     */
+    storage?: () => Storage | undefined;
+    /**
+     * @en Function to get initial color mode from system preference
+     * @zh 从系统偏好获取初始颜色模式的函数
+     */
+    initialValueDetector?: () => T;
+    /**
+     * @en Mapping of color modes to their corresponding class names or attribute values
+     * @zh 颜色模式到对应类名或属性值的映射
+     */
+    modeClassNames?: Partial<Record<T, string>>;
+}
+/**
+ * @title useColorMode
+ * @returns_en A tuple with the following elements:
+ * - The current color mode value.
+ * - A function to set the color mode.
+ * - A function to cycle through available modes.
+ * @returns 包含以下元素的元组：
+ * - 当前颜色模式值。
+ * - 设置颜色模式的函数。
+ * - 循环切换可用模式的函数。
+ */
+type UseColorMode<T extends string = string> = (options: UseColorModeOptions<T>) => readonly [
+    T | null,
+    React.Dispatch<React.SetStateAction<T | null>>,
+    () => void
+];
+
+declare const useColorMode: UseColorMode;
+
 /**
  * @title useDocumentVisiblity
  * @returns_en document visibility
@@ -3596,5 +3733,5 @@ type Use = <T>(
  */
 usable: Usable<T>) => T;
 
-export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBroadcastChannel, useClickOutside, useClipboard, useControlled, useCookie, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
-export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };
+export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBoolean, useBroadcastChannel, useClickOutside as useClickAway, useClickOutside, useClipboard, useColorMode, useControlled, useCookie, useClipboard as useCopyToClipboard, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMap, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
+export type { ColorScheme, Contrast, DepsEqualFnType, EventSourceStatus, EventType, INetworkInformation, IUseNetworkState, KeyModifier, Pausable, Platform, PossibleRef, Use, UseActiveElement, UseAsyncEffect, UseBoolean, UseBroadcastChannel, UseBroadcastChannelOptions, UseBroadcastChannelReturn, UseClickOutside, UseClipboard, UseColorMode, UseColorModeOptions, UseControlled, UseCookie, UseCookieState, UseCountDown, UseCounter, UseCssVar, UseCssVarOptions, UseCustomCompareEffect, UseCycleList, UseDarkMode, UseDarkOptions, UseDebounce, UseDebounceFn, UseDeepCompareEffect, UseDevicePixelRatio, UseDevicePixelRatioReturn, UseDisclosure, UseDisclosureProps, UseDocumentVisibility, UseDoubleClick, UseDoubleClickProps, UseDraggable, UseDraggableOptions, UseDropZone, UseElementBounding, UseElementBoundingOptions, UseElementBoundingReturn, UseElementByPoint, UseElementByPointOptions, UseElementByPointReturn, UseElementSize, UseElementVisibility, UseEvent, UseEventEmitter, UseEventEmitterDisposable, UseEventEmitterEvent, UseEventEmitterEventOnce, UseEventEmitterListener, UseEventEmitterReturn, UseEventListener, UseEventSource, UseEventSourceAutoReconnectOptions, UseEventSourceOptions, UseEventSourceReturn, UseEyeDropper, UseEyeDropperOpenOptions, UseEyeDropperOpenReturnType, UseFavicon, UseFetchEventSource, UseFetchEventSourceAutoReconnectOptions, UseFetchEventSourceMessage, UseFetchEventSourceOptions, UseFetchEventSourceReturn, UseFetchEventSourceStatus, UseFileDialog, UseFileDialogOptions, UseFirstMountState, UseFocus, UseFps, UseFpsOptions, UseFullScreenOptions, UseFullscreen, UseGeolocation, UseHover, UseIdle, UseInfiniteScroll, UseInfiniteScrollArrivedState, UseInfiniteScrollDirection, UseInfiniteScrollLoadMore, UseInfiniteScrollOptions, UseIntersectionObserver, UseInterval, UseIntervalOptions, UseKeyModifier, UseLatest, UseLocalStorage, UseLocalStorageOptions, UseLocalStorageSerializer, UseLocationSelector, UseLongPress, UseLongPressOptions, UseMap, UseMeasure, UseMeasureRect, UseMediaDeviceOptions, UseMediaDevices, UseMediaQuery, UseMergedRef, UseMobileLandscape, UseModifierOptions, UseMount, UseMountedState, UseMouse, UseMouseCursorState, UseMousePressed, UseMousePressedOptions, UseMousePressedSourceType, UseMutationObserver, UseNetwork, UseObjectUrl, UseOnline, UseOrientation, UseOrientationLockType, UseOrientationState, UseOrientationType, UsePageLeave, UsePermission, UsePermissionDescriptorNamePolyfill, UsePermissionGeneralPermissionDescriptor, UsePermissionState, UsePlatform, UsePlatformProps, UsePlatformReturn, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePrevious, UseRafFn, UseRafState, UseReducedMotion, UseResizeObserver, UseScreenSafeArea, UseScriptTag, UseScriptTagOptions, UseScriptTagStatus, UseScroll, UseScrollArrivedState, UseScrollDirection, UseScrollIntoView, UseScrollIntoViewAnimation, UseScrollIntoViewParams, UseScrollLock, UseScrollOffset, UseScrollOptions, UseSessionStorage, UseSessionStorageOptions, UseSessionStorageSerializer, UseSetState, UseSticky, UseStickyParams, UseSupported, UseTextDirection, UseTextDirectionOptions, UseTextDirectionValue, UseTextSelection, UseThrottle, UseThrottleFn, UseTimeout, UseTimeoutFn, UseTimeoutFnOptions, UseTimeoutOptions, UseTitle, UseToggle, UseUnmount, UseUpdate, UseWebNotification, UseWebNotificationReturn, UseWebNotificationShow, UseWindowScroll, UseWindowScrollState, UseWindowSize, UseWindowsFocus };

package/dist/index.mjs

@@ -705,49 +705,132 @@ function useStorage(key, defaultValue, getStorage = ()=>isBrowser ? sessionStora
     ];
 }
 
-function value() {
-    return window.matchMedia('(prefers-color-scheme: dark)').matches;
-}
-const useDarkMode = (options)=>{
-    const { selector = 'html', attribute = 'class', classNameDark = '', classNameLight = '', storageKey = 'reactuses-color-scheme', storage = ()=>isBrowser ? localStorage : undefined, defaultValue = false } = options;
-    const [dark, setDark] = useStorage(storageKey, defaultValue, storage, {
-        mountStorageValue: value
+const useColorMode = (options)=>{
+    const { selector = 'html', attribute = 'class', modes, defaultValue, storageKey = 'reactuses-color-mode', storage = ()=>isBrowser ? localStorage : undefined, initialValueDetector, modeClassNames = {} } = options;
+    const initialValueDetectorRef = useLatest(initialValueDetector);
+    // Validate modes array
+    if (!modes || modes.length === 0) {
+        throw new Error('useColorMode: modes array cannot be empty');
+    }
+    // Get initial value from detector or use first mode as fallback
+    const getInitialValue = useCallback(()=>{
+        if (initialValueDetectorRef.current) {
+            const initialValueDetector = initialValueDetectorRef.current;
+            try {
+                const detectedValue = initialValueDetector();
+                return modes.includes(detectedValue) ? detectedValue : modes[0];
+            } catch (e) {
+                return modes[0];
+            }
+        }
+        return defaultValue && modes.includes(defaultValue) ? defaultValue : modes[0];
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [
+        defaultValue,
+        JSON.stringify(modes)
+    ]);
+    const [colorMode, setColorMode] = useStorage(storageKey, defaultValue, storage, {
+        mountStorageValue: getInitialValue
     });
-    useEffect(()=>{
+    // Apply color mode to DOM element
+    useDeepCompareEffect(()=>{
         var _window;
+        if (!colorMode) return;
         const element = (_window = window) == null ? void 0 : _window.document.querySelector(selector);
-        if (!element) {
-            return;
-        }
+        if (!element) return;
+        // Remove all existing mode classes/attributes
+        modes.forEach((mode)=>{
+            const className = modeClassNames[mode] || mode;
+            if (attribute === 'class') {
+                element.classList.remove(className);
+            } else {
+                element.removeAttribute(attribute);
+            }
+        });
+        // Apply current mode class/attribute
+        const currentClassName = modeClassNames[colorMode] || colorMode;
         if (attribute === 'class') {
-            dark && classNameDark && element.classList.add(classNameDark);
-            !dark && classNameLight && element.classList.add(classNameLight);
+            element.classList.add(currentClassName);
         } else {
-            dark && classNameDark && element.setAttribute(attribute, classNameDark);
-            !dark && classNameLight && element.setAttribute(attribute, classNameLight);
+            element.setAttribute(attribute, currentClassName);
         }
         return ()=>{
-            if (!element) {
-                return;
-            }
+            // Cleanup: remove current mode class/attribute
             if (attribute === 'class') {
-                dark && classNameDark && element.classList.remove(classNameDark);
-                !dark && classNameLight && element.classList.remove(classNameLight);
+                element.classList.remove(currentClassName);
             } else {
-                dark && classNameDark && element.removeAttribute(attribute);
-                !dark && classNameLight && element.removeAttribute(attribute);
+                element.removeAttribute(attribute);
             }
         };
     }, [
+        colorMode,
+        selector,
+        attribute,
+        modes,
+        modeClassNames
+    ]);
+    const cycle = useEvent(()=>{
+        if (!colorMode) return;
+        const currentIndex = modes.indexOf(colorMode);
+        const nextIndex = (currentIndex + 1) % modes.length;
+        setColorMode(modes[nextIndex]);
+    });
+    return [
+        colorMode,
+        setColorMode,
+        cycle
+    ];
+};
+
+function getSystemPreference() {
+    return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+}
+const useDarkMode = (options)=>{
+    const { selector = 'html', attribute = 'class', classNameDark = '', classNameLight = '', storageKey = 'reactuses-color-scheme', storage = ()=>isBrowser ? localStorage : undefined, defaultValue = false } = options;
+    // Convert boolean-based options to string-based options for useColorMode
+    const [colorMode, setColorMode] = useColorMode({
+        selector,
         attribute,
-        classNameDark,
-        classNameLight,
+        modes: [
+            'light',
+            'dark'
+        ],
+        defaultValue: defaultValue ? 'dark' : 'light',
+        storageKey,
+        storage,
+        initialValueDetector: getSystemPreference,
+        modeClassNames: {
+            dark: classNameDark,
+            light: classNameLight
+        }
+    });
+    // Convert string mode back to boolean
+    const dark = colorMode === 'dark';
+    // Toggle function that switches between dark and light
+    const toggle = useCallback(()=>{
+        setColorMode(dark ? 'light' : 'dark');
+    }, [
         dark,
-        selector
+        setColorMode
+    ]);
+    // Set function that accepts boolean value
+    const setDark = useCallback((value)=>{
+        if (typeof value === 'function') {
+            const currentDark = colorMode === 'dark';
+            const newDark = value(currentDark);
+            if (newDark !== null) {
+                setColorMode(newDark ? 'dark' : 'light');
+            }
+        } else if (value !== null) {
+            setColorMode(value ? 'dark' : 'light');
+        }
+    }, [
+        colorMode,
+        setColorMode
     ]);
     return [
         dark,
-        ()=>setDark((dark)=>!dark),
+        toggle,
         setDark
     ];
 };
@@ -3717,6 +3800,29 @@ const useBroadcastChannel = (options)=>{
     };
 };
 
+const useBoolean = (initialValue = false)=>{
+    const [value, setValue] = useState(initialValue);
+    const setTrue = useEvent(()=>{
+        setValue(true);
+    });
+    const setFalse = useEvent(()=>{
+        setValue(false);
+    });
+    const toggle = useEvent(()=>{
+        setValue((prev)=>!prev);
+    });
+    const handleSetValue = useEvent((newValue)=>{
+        setValue(newValue);
+    });
+    return {
+        value,
+        setValue: handleSetValue,
+        setTrue,
+        setFalse,
+        toggle
+    };
+};
+
 const useDevicePixelRatio = ()=>{
     const [pixelRatio, setPixelRatio] = useState(1);
     const observe = useCallback(()=>{
@@ -4028,4 +4134,66 @@ const useFetchEventSource = (url, options = {})=>{
     };
 };
 
-export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBroadcastChannel, useClickOutside, useClipboard, useControlled, useCookie, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };
+const useMap = (initialValue)=>{
+    // avoid exec init code every render
+    const initFunc = ()=>{
+        if (typeof initialValue === 'function') {
+            const result = initialValue();
+            return result instanceof Map ? new Map(result) : new Map(result);
+        }
+        if (initialValue instanceof Map) {
+            return new Map(initialValue);
+        }
+        if (Array.isArray(initialValue)) {
+            return new Map(initialValue);
+        }
+        return new Map();
+    };
+    const [map, setMap] = useState(initFunc);
+    const set = useEvent((key, value)=>{
+        setMap((prevMap)=>{
+            const newMap = new Map(prevMap);
+            newMap.set(key, value);
+            return newMap;
+        });
+    });
+    const get = useCallback((key)=>{
+        return map.get(key);
+    }, [
+        map
+    ]);
+    const remove = useEvent((key)=>{
+        const hasKey = map.has(key);
+        if (hasKey) {
+            setMap((prevMap)=>{
+                const newMap = new Map(prevMap);
+                newMap.delete(key);
+                return newMap;
+            });
+        }
+        return hasKey;
+    });
+    const has = useCallback((key)=>{
+        return map.has(key);
+    }, [
+        map
+    ]);
+    const clear = useEvent(()=>{
+        setMap(new Map());
+    });
+    const reset = useEvent(()=>{
+        setMap(initFunc());
+    });
+    return {
+        map,
+        set,
+        get,
+        remove,
+        has,
+        clear,
+        reset,
+        size: map.size
+    };
+};
+
+export { assignRef, defaultOptions, mergeRefs, use, useActiveElement, useAsyncEffect, useBoolean, useBroadcastChannel, useClickOutside as useClickAway, useClickOutside, useClipboard, useColorMode, useControlled, useCookie, useClipboard as useCopyToClipboard, useCountDown, useCounter, useCssVar, useCustomCompareEffect, useCycleList, useDarkMode, useDebounce, useDebounceFn, useDeepCompareEffect, useDevicePixelRatio, useDisclosure, useDocumentVisibility, useDoubleClick, useDraggable, useDropZone, useElementBounding, useElementByPoint, useElementSize, useElementVisibility, useEvent, useEventEmitter, useEventListener, useEventSource, useEyeDropper, useFavicon, useFetchEventSource, useFileDialog, useFirstMountState, useFocus, useFps, useFullscreen, useGeolocation, useHover, useIdle, useInfiniteScroll, useIntersectionObserver, useInterval, useIsomorphicLayoutEffect, useKeyModifier, useLatest, useLocalStorage, useLocationSelector, useLongPress, useMap, useMeasure, useMediaDevices, useMediaQuery, useMergedRefs, useMobileLandscape, useMount, useMountedState, useMouse, useMousePressed, useMutationObserver, useNetwork, useObjectUrl, useOnceEffect, useOnceLayoutEffect, useOnline, useOrientation, usePageLeave, usePermission, usePlatform, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePrevious, useRafFn, useRafState, useReducedMotion, useResizeObserver, useScreenSafeArea, useScriptTag, useScroll, useScrollIntoView, useScrollLock, useSessionStorage, useSetState, useSticky, useSupported, useTextDirection, useTextSelection, useThrottle, useThrottleFn, useTimeout, useTimeoutFn, useTitle, useToggle, useUnmount, useUpdate, useUpdateEffect, useUpdateLayoutEffect, useWebNotification, useWindowScroll, useWindowSize, useWindowsFocus };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactuses/core",
-  "version": "6.0.7",
+  "version": "6.1.0-beta.1",
   "license": "Unlicense",
   "homepage": "https://www.reactuse.com/",
   "repository": {