

Custom hook that handles boolean state with useful utility functions.

## Usage [#usage]

```tsx
import { useBoolean } from "@tilt-legal/cubitt-components/utilities/hooks";

const { value, setTrue, setFalse, toggle } = useBoolean(true);
```

## API [#api]

### Signature [#signature]

```ts
declare function useBoolean(defaultValue?: boolean): UseBooleanReturn;
```

### Parameters [#parameters]

| Parameter        | Type      | Description                               | Default |
| ---------------- | --------- | ----------------------------------------- | ------- |
| `[defaultValue]` | `boolean` | The initial value for the boolean state . | false   |

### Return Value [#return-value]

| Value    | Type               | Description                                                                                 |
| -------- | ------------------ | ------------------------------------------------------------------------------------------- |
| `return` | `UseBooleanReturn` | An object containing the boolean state value and utility functions to manipulate the state. |
