@qazuor/react-hooks/src/hooks/useBoolean.ts

A comprehensive collection of production-ready React hooks for modern web applications. Features type-safe implementations, extensive testing, and zero dependencies. Includes hooks for state management, browser APIs, user interactions, and development uti

import { useCallback, useState } from 'react';

type UseBooleanReturn = {
    value: boolean;
    setTrue: () => void;
    setFalse: () => void;
    toggle: () => void;
    setValue: (value: boolean) => void;
};

/**
 * useBoolean
 *
 * @description Manages a boolean state with convenient methods to set it to true, false, or toggle it.
 *
 * @param {boolean} [initialValue=false] - Optional initial value.
 * @returns {UseBooleanReturn} - An object containing:
 *  - `value`: The current boolean value.
 *  - `setTrue()`: Sets the value to `true`.
 *  - `setFalse()`: Sets the value to `false`.
 *  - `toggle()`: Toggles the value between `true` and `false`.
 *  - `setValue()`: Directly sets the value to the given boolean.
 *
 * @example
 * ```ts
 * const { value, setTrue, setFalse, toggle } = useBoolean();
 * setTrue();  // value -> true
 * toggle();   // value -> false
 * ```
 */
export function useBoolean(initialValue = false): UseBooleanReturn {
    const [value, setValue] = useState(initialValue);

    const setTrue = useCallback(() => setValue(true), []);
    const setFalse = useCallback(() => setValue(false), []);
    const toggle = useCallback(() => setValue((v) => !v), []);
    const setValueDirect = useCallback((newValue: boolean) => setValue(newValue), []);

    return { value, setTrue, setFalse, toggle, setValue: setValueDirect };
}