> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# ITheme

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/theme/index.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Theme used to customize selected parts of the UI

**Signature:**

```typescript
export interface ITheme 
```

## Remarks

Only the primary color main value is mandatory

Optional properties are replaced with the default values

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [analyticalDesigner?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemeanalyticaldesigner) |  | [IThemeAnalyticalDesigner](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemeanalyticaldesigner/index.md) | **_(BETA)_** _(Optional)_ Analytical designer specific properties |
| [assets?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemeassets) |  | [IThemeAssets](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemeassets/index.md) | **_(ALPHA)_** _(Optional)_ Image assets offered to documents |
| [button?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemebutton) |  | [IThemeButton](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemebutton/index.md) | **_(BETA)_** _(Optional)_ Button customizable UI properties |
| [chart?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemechart) |  | [IThemeChart](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemechart/index.md) | **_(BETA)_** _(Optional)_ Chart customizable UI properties |
| [dashboards?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemedashboards) |  | [IThemeDashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemedashboard/index.md) | **_(BETA)_** _(Optional)_ KPI dashboards specific properties |
| [documents?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemedocuments) |  | [IThemeDocuments](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemedocuments/index.md) | **_(ALPHA)_** _(Optional)_ How documents with content version 2 look. Version 1 documents read `reports` until the switch to version 2. |
| [header?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemeheader) |  | [IThemeHeader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemeheader/index.md) | **_(ALPHA)_** _(Optional)_ Application header (top bar) specific properties |
| [images?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemeimages) |  | [IThemeImages](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemeimages/index.md) | **_(BETA)_** _(Optional)_ Images Customizable images used in the UI |
| [kpi?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemekpi) |  | [IThemeKpi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemekpi/index.md) | **_(BETA)_** _(Optional)_ Global Kpi/Headline customizable UI properties |
| [message?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithememessage) |  | [IThemeMessage](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithememessage/index.md) | **_(BETA)_** _(Optional)_ Non-toast message specific properties |
| [modal?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithememodal) |  | [IThemeModal](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithememodal/index.md) | **_(BETA)_** _(Optional)_ Modal customizable UI properties |
| [palette?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemepalette) |  | [IThemePalette](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemepalette/index.md) | **_(BETA)_** _(Optional)_ Customizable palette of major colors Inspired by Material UI palette: https://material-ui.com/customization/palette/ |
| [reports?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemereports) |  | [IThemePublisher](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemepublisher/index.md) | **_(ALPHA)_** _(Optional)_ Publisher-specific properties |
| [table?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemetable) |  | [IThemeTable](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemetable/index.md) | **_(BETA)_** _(Optional)_ Table customizable UI properties |
| [toastMessage?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemetoastmessage) |  | [IThemeToastMessage](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemetoastmessage/index.md) | **_(BETA)_** _(Optional)_ Toast message specific properties |
| [toolbar?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemetoolbar) |  | [IThemeToolbar](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemetoolbar/index.md) | **_(ALPHA)_** _(Optional)_ Toolbar customizable UI properties |
| [tooltip?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemetooltip) |  | [IThemeTooltip](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemetooltip/index.md) | **_(BETA)_** _(Optional)_ Tooltip customizable UI properties |
| [typography?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemetypography) |  | [IThemeTypography](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ithemetypography/index.md) | **_(BETA)_** _(Optional)_ Typography Definition of both normal and bold font URIs |
| [version?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itheme/index.md#ithemeversion) |  | "2" | **_(BETA)_** _(Optional)_ Shape version of the theme content. Absent means version 1: a theme created before the `reports` and `assets` sections existed. |

## Property details

### ITheme.analyticalDesigner

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Analytical designer specific properties

**Signature:**

```typescript
analyticalDesigner?: IThemeAnalyticalDesigner;
```

### ITheme.assets

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Image assets offered to documents

**Signature:**

```typescript
assets?: IThemeAssets;
```

### ITheme.button

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Button customizable UI properties

**Signature:**

```typescript
button?: IThemeButton;
```

### ITheme.chart

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Chart customizable UI properties

**Signature:**

```typescript
chart?: IThemeChart;
```

### ITheme.dashboards

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

KPI dashboards specific properties

**Signature:**

```typescript
dashboards?: IThemeDashboard;
```

### ITheme.documents

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

How documents with content version 2 look. Version 1 documents read `reports` until the switch to version 2.

**Signature:**

```typescript
documents?: IThemeDocuments;
```

### ITheme.header

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Application header (top bar) specific properties

**Signature:**

```typescript
header?: IThemeHeader;
```

### ITheme.images

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Images

Customizable images used in the UI

**Signature:**

```typescript
images?: IThemeImages;
```

### ITheme.kpi

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Global Kpi/Headline customizable UI properties

**Signature:**

```typescript
kpi?: IThemeKpi;
```

### ITheme.message

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Non-toast message specific properties

**Signature:**

```typescript
message?: IThemeMessage;
```

### ITheme.modal

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Modal customizable UI properties

**Signature:**

```typescript
modal?: IThemeModal;
```

### ITheme.palette

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Customizable palette of major colors

Inspired by Material UI palette: https://material-ui.com/customization/palette/

**Signature:**

```typescript
palette?: IThemePalette;
```

### ITheme.reports

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Publisher-specific properties

**Signature:**

```typescript
reports?: IThemePublisher;
```

### ITheme.table

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Table customizable UI properties

**Signature:**

```typescript
table?: IThemeTable;
```

### ITheme.toastMessage

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Toast message specific properties

**Signature:**

```typescript
toastMessage?: IThemeToastMessage;
```

### ITheme.toolbar

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Toolbar customizable UI properties

**Signature:**

```typescript
toolbar?: IThemeToolbar;
```

### ITheme.tooltip

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Tooltip customizable UI properties

**Signature:**

```typescript
tooltip?: IThemeTooltip;
```

### ITheme.typography

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Typography

Definition of both normal and bold font URIs

**Signature:**

```typescript
typography?: IThemeTypography;
```

### ITheme.version

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Shape version of the theme content. Absent means version 1: a theme created before the `reports` and `assets` sections existed.

**Signature:**

```typescript
version?: "2";
```
