@supunlakmal/hooks/dist/hooks/state-management/useToggle.js

A collection of reusable React hooks

import { useState, useCallback } from 'react';
/**
 * A simple hook to manage boolean state with a toggle function.
 *
 * @param initialValue - The initial boolean state (defaults to false).
 * @returns An array containing:
 *          - The current boolean value.
 *          - A function to toggle the value.
 *          - A function to explicitly set the value to true.
 *          - A function to explicitly set the value to false.
 */
export const useToggle = (initialValue = false) => {
    const [value, setValue] = useState(initialValue);
    // useCallback ensures the toggle function identity is stable across re-renders
    // unless its dependencies change (which they don't here).
    const toggle = useCallback(() => {
        // Use the functional update form to ensure we always toggle based on the latest state
        setValue((prevValue) => !prevValue);
    }, []); // No dependencies, function never needs to be recreated
    // Explicit setters using useCallback for stability
    const setOn = useCallback(() => {
        setValue(true);
    }, []);
    const setOff = useCallback(() => {
        setValue(false);
    }, []);
    return [value, toggle, setOn, setOff];
};
//# sourceMappingURL=useToggle.js.map