# ThemeInput

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

type exported by @mwillbanks/tuil-theme.



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

## type [#type]

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

```ts
export type ThemeInput = DeepPartial<Theme>;
```

## Members [#members]

| Member        | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | Related types                                                    |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `id`          | `string \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | No       | The `id` member uses the `string \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | —                                                                |
| `colorScheme` | `ColorScheme \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | No       | The `colorScheme` member uses the `ColorScheme \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [`ColorScheme`](/tuil/docs/reference/packages/theme/api/color-scheme) |
| `colors`      | `&#123; readonly background?: string \| undefined; readonly foreground?: string \| undefined; readonly muted?: string \| undefined; readonly subtle?: string \| undefined; readonly border?: string \| undefined; readonly primary?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly secondary?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly success?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly warning?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly danger?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly info?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; &#125; \| undefined` | No       | The `colors` member uses the `&#123; readonly background?: string \| undefined; readonly foreground?: string \| undefined; readonly muted?: string \| undefined; readonly subtle?: string \| undefined; readonly border?: string \| undefined; readonly primary?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly secondary?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly success?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly warning?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly danger?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; readonly info?: &#123; readonly foreground?: string \| undefined; readonly background?: string \| undefined; readonly border?: string \| undefined; &#125; \| undefined; &#125; \| undefined` contract. | —                                                                |
| `spacing`     | `&#123; readonly sm?: number \| undefined; readonly md?: number \| undefined; readonly lg?: number \| undefined; readonly none?: number \| undefined; readonly xs?: number \| undefined; readonly xl?: number \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | No       | The `spacing` member uses the `&#123; readonly sm?: number \| undefined; readonly md?: number \| undefined; readonly lg?: number \| undefined; readonly none?: number \| undefined; readonly xs?: number \| undefined; readonly xl?: number \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | —                                                                |
| `borders`     | `&#123; readonly none?: readonly [string, string, string, string, string, string] \| undefined; readonly single?: readonly [string, string, string, string, string, string] \| undefined; readonly round?: readonly [string, string, string, string, string, string] \| undefined; readonly double?: readonly [string, string, string, string, string, string] \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | No       | The `borders` member uses the `&#123; readonly none?: readonly [string, string, string, string, string, string] \| undefined; readonly single?: readonly [string, string, string, string, string, string] \| undefined; readonly round?: readonly [string, string, string, string, string, string] \| undefined; readonly double?: readonly [string, string, string, string, string, string] \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | —                                                                |
| `typography`  | `&#123; readonly headingBold?: boolean \| undefined; readonly codeColor?: string \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | No       | The `typography` member uses the `&#123; readonly headingBold?: boolean \| undefined; readonly codeColor?: string \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | —                                                                |
| `icons`       | `&#123; readonly success?: string \| undefined; readonly warning?: string \| undefined; readonly error?: string \| undefined; readonly pending?: string \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | No       | The `icons` member uses the `&#123; readonly success?: string \| undefined; readonly warning?: string \| undefined; readonly error?: string \| undefined; readonly pending?: string \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | —                                                                |
| `motion`      | `&#123; readonly enabled?: boolean \| undefined; readonly spinnerFrames?: readonly string[] \| undefined; readonly interval?: number \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | No       | The `motion` member uses the `&#123; readonly enabled?: boolean \| undefined; readonly spinnerFrames?: readonly string[] \| undefined; readonly interval?: number \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | —                                                                |
| `components`  | `&#123; readonly [x: string]: &#123; readonly defaultProps?: &#123; readonly [x: string]: unknown; &#125; \| undefined; readonly variants?: &#123; readonly [x: string]: &#123; readonly [x: string]: unknown; &#125; \| undefined; &#125; \| undefined; readonly sizes?: &#123; readonly [x: string]: &#123; readonly [x: string]: unknown; &#125; \| undefined; &#125; \| undefined; &#125; \| undefined; &#125; \| undefined`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | No       | The `components` member uses the `&#123; readonly [x: string]: &#123; readonly defaultProps?: &#123; readonly [x: string]: unknown; &#125; \| undefined; readonly variants?: &#123; readonly [x: string]: &#123; readonly [x: string]: unknown; &#125; \| undefined; &#125; \| undefined; readonly sizes?: &#123; readonly [x: string]: &#123; readonly [x: string]: unknown; &#125; \| undefined; &#125; \| undefined; &#125; \| undefined; &#125; \| undefined` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | —                                                                |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`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)