hooks-belt/dist/hooks/useToggle.d.ts

A comprehensive collection of useful React hooks for common use cases

/**
 * A hook that provides a boolean state with toggle functionality.
 * Useful for managing boolean states like modals, dropdowns, etc.
 *
 * @param initialValue - The initial boolean value (default: false)
 * @returns A tuple with the current value and toggle functions
 *
 * @example
 * ```tsx
 * const [isOpen, toggle, setOpen, setClosed] = useToggle(false)
 *
 * return (
 *   <div>
 *     <button onClick={toggle}>Toggle</button>
 *     <button onClick={setOpen}>Open</button>
 *     <button onClick={setClosed}>Close</button>
 *     {isOpen && <Modal />}
 *   </div>
 * )
 * ```
 */
export declare function useToggle(initialValue?: boolean): [
    boolean,
    () => void,
    () => void,
    () => void
];
//# sourceMappingURL=useToggle.d.ts.map