# compileUtilities

Source: /tuil/docs/reference/packages/theme/api/compile-utilities
Locale: en

function exported by @mwillbanks/tuil-theme.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-theme`.

```ts
export function compileUtilities(
  className: string,
  theme: Theme,
  state: Readonly<Record<string, boolean>> = {},
): TerminalStyleProps;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member      | Type                                | Required | Description                                                        | Related types                                       |
| ----------- | ----------------------------------- | -------- | ------------------------------------------------------------------ | --------------------------------------------------- |
| `className` | `string`                            | Yes      | Supplies the `className` value as `string`.                        | —                                                   |
| `theme`     | `Theme`                             | Yes      | Supplies the `theme` value as `Theme`.                             | [`Theme`](/tuil/docs/reference/packages/theme/api/theme) |
| `state`     | `Readonly<Record<string, boolean>>` | No       | Supplies the `state` value as `Readonly<Record<string, boolean>>`. | —                                                   |

## Returns [#returns]

`TerminalStyleProps` — Returns a value that satisfies `TerminalStyleProps`.

Related types: [`TerminalStyleProps`](/tuil/docs/reference/packages/theme/api/terminal-style-props)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TerminalStyleProps`](/tuil/docs/reference/packages/theme/api/terminal-style-props)
* [`Theme`](/tuil/docs/reference/packages/theme/api/theme)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/theme/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-theme](/tuil/docs/reference/packages/theme)