

Custom hook that returns the current state of the dark mode.

## Usage [#usage]

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

const { isDarkMode, toggle, enable, disable, set } = useDarkMode({ defaultValue: true });
```

## API [#api]

### Signature [#signature]

```ts
declare function useDarkMode(options?: DarkModeOptions): DarkModeReturn;
```

### Parameters [#parameters]

| Parameter   | Type               | Description                                          | Default |
| ----------- | ------------------ | ---------------------------------------------------- | ------- |
| `[options]` | `?DarkModeOptions` | The initial value of the dark mode, default `false`. | -       |

### Return Value [#return-value]

| Value    | Type             | Description                                                     |
| -------- | ---------------- | --------------------------------------------------------------- |
| `return` | `DarkModeReturn` | An object containing the dark mode's state and its controllers. |
