useBoolean()

useBoolean(initialValue?): object

Defined in: src/hooks/state/useBoolean.ts:39

A custom React hook for managing a boolean state with helper functions. Provides functions to toggle the value, set it to true, or set it to false.

Parameters

initialValue?

boolean = false

The initial value of the boolean state. Defaults to false.

Returns

object

An object containing:

• value: The current boolean state.
• toggle: Function to invert the current value.
• setTrue: Function to set the value to true.
• setFalse: Function to set the value to false.

value

value: boolean

toggle()

toggle: () => void

Returns

void

setTrue()

setTrue: () => void

Returns

void

setFalse()

setFalse: () => void

Returns

void

Example

import { useBoolean } from '@zl-asica/react';

const MyComponent = () => {
  const { value, toggle, setTrue, setFalse } = useBoolean(false);

  return (
    <div>
      <p>Value: {value ? 'True' : 'False'}</p>
      <button onClick={toggle}>Toggle</button>
      <button onClick={setTrue}>Set True</button>
      <button onClick={setFalse}>Set False</button>
    </div>
  );
};