

Custom hook that manages ternary (system, dark, light) dark mode with local storage support.

## Usage [#usage]

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

const { isDarkMode, ternaryDarkMode, setTernaryDarkMode, toggleTernaryDarkMode } = useTernaryDarkMode({ defaultValue: 'dark' });
// Access and use the dark mode state and provided helper functions.
```

## API [#api]

### Signature [#signature]

```ts
declare function useTernaryDarkMode({ defaultValue, localStorageKey, initializeWithValue, }?: TernaryDarkModeOptions): TernaryDarkModeReturn;
```

### Parameters [#parameters]

| Parameter   | Type                      | Description | Default                                        |   |
| ----------- | ------------------------- | ----------- | ---------------------------------------------- | - |
| `[options]` | \`?TernaryDarkModeOptions | string\`    | Options or the local storage key for the hook. | - |

### Return Value [#return-value]

| Value    | Type                    | Description                                                    |
| -------- | ----------------------- | -------------------------------------------------------------- |
| `return` | `TernaryDarkModeReturn` | An object containing the dark mode state and helper functions. |
