# ThemeState

Canonical page: https://www.adaptabletools.com/docs/reference/themestate

Theme section of Adaptable State, including Initial State.

`CurrentTheme` is `'light'` (the default), `'dark'`, or `'os'`. `SystemThemes` limits which shipped themes are offered. Omit it to offer all of them.

```ts title="TypeScript"
export interface ThemeState extends BaseState 
```

###### Extends

[`BaseState`](https://www.adaptabletools.com/docs/reference/basestate.md)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [CurrentTheme](https://www.adaptabletools.com/docs/reference/themestate.md#currenttheme) | [`SystemThemeName`](https://www.adaptabletools.com/docs/reference/systemthemename.md) | Shipped theme that is active: `'light'`, `'dark'`, or `'os'` (follows the operating system). When omitted, the theme is `'light'`. |
| [SystemThemes](https://www.adaptabletools.com/docs/reference/themestate.md#systemthemes) | `(`[`SystemThemeEntry`](https://www.adaptabletools.com/docs/reference/systemthemeentry.md)` \| `[`AdaptableTheme`](https://www.adaptabletools.com/docs/reference/adaptabletheme.md)`)[]` | Which shipped themes are available; pass theme name string, or `{ Name, AgThemeMode? }` to pair a custom AG Grid theme mode; leave unset for all shipped themes |

## Property Details

### CurrentTheme

Shipped theme that is active: `'light'`, `'dark'`, or `'os'` (follows the operating system). When omitted, the theme is `'light'`.

```ts title="TypeScript"
CurrentTheme?: SystemThemeName;
```

###### Property Value

[`SystemThemeName`](https://www.adaptabletools.com/docs/reference/systemthemename.md)

### SystemThemes

Which shipped themes are available; pass theme name string, or `{ Name, AgThemeMode? }` to pair a custom AG Grid theme mode; leave unset for all shipped themes

```ts title="TypeScript"
SystemThemes?: (SystemThemeEntry | AdaptableTheme)[];
```

###### Property Value

`(`[`SystemThemeEntry`](https://www.adaptabletools.com/docs/reference/systemthemeentry.md)` | `[`AdaptableTheme`](https://www.adaptabletools.com/docs/reference/adaptabletheme.md)`)[]`

### UserThemes

Custom themes provided by developers (deprecated)

```ts title="TypeScript"
UserThemes?: AdaptableTheme[];
```

###### Deprecated

Will be removed in next major version. Customise shipped `light` / `dark` themes via CSS variable overrides instead.

###### Property Value

[`AdaptableTheme`](https://www.adaptabletools.com/docs/reference/adaptabletheme.md)`[]`
