DocsObject referenceView source

Theme

Theme bundle used by the design system. In design.theme, 'id' resolves a themes catalog record as the base; any sibling fields override the resolved theme. The string shorthand on design.theme is equivalent to…

Metadata

Definition: #/$defs/Theme
Type: object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
id	string	—	Theme reference. Resolves to the 'id' of a 'themes' catalog record. Accepts a bare id (lowercase kebab-case, e.g. 'minimal'), an HTTPS URL pointing at a record file, or a 'pkg:' reference. Field overrides on the surrounding Theme object take precedence over the resolved theme. R…
name	string	—	Human-readable theme name shown in pickers.
summary	string	—	One-sentence positioning of the theme - when to reach for it.
description	string	—	Longer prose describing what the theme looks and feels like and the kinds of decks it suits.
colorScheme	string \| ref:ColorScheme	—	Default color scheme for this theme. A string resolves against catalogs.colorSchemes; an object may provide an 'id' base reference plus overrides.
fontScheme	string \| ref:FontScheme	—	Default font scheme for this theme. A string resolves against catalogs.fontSchemes; an object may provide an 'id' base reference plus overrides.
background	ref:BackgroundShortcut \| ref:Background	—	Default background for this theme. String shorthand accepts theme slots ('light1', 'light2', 'dark1', 'dark2') or hex colors.
dimensions	ref:DimensionPreset \| ref:Dimensions	—	Default slide size for this theme. A string preset is equivalent to { preset: value }.
tags	array<string>	—	Free-form labels for filtering and search.

`id`

typestringrequirednodefault—

Theme reference. Resolves to the 'id' of a 'themes' catalog record. Accepts a bare id (lowercase kebab-case, e.g. 'minimal'), an HTTPS URL pointing at a record file, or a 'pkg:' reference. Field overrides on the surrounding Theme object take precedence over the resolved theme. R…

id.json

{
  "id": "minimal"
}

`name`

typestringrequirednodefault—

Human-readable theme name shown in pickers.

name.json

{
  "name": "Minimal"
}

`summary`

typestringrequirednodefault—

One-sentence positioning of the theme - when to reach for it.

summary.json

{
  "summary": "summary-value"
}

`description`

typestringrequirednodefault—

Longer prose describing what the theme looks and feels like and the kinds of decks it suits.

description.json

{
  "description": "description-value"
}

`colorScheme`

typestring | ref:ColorSchemerequirednodefault—

Default color scheme for this theme. A string resolves against catalogs.colorSchemes; an object may provide an 'id' base reference plus overrides.

colorScheme.json

{
  "colorScheme": "cool-horizon"
}

`fontScheme`

typestring | ref:FontSchemerequirednodefault—

Default font scheme for this theme. A string resolves against catalogs.fontSchemes; an object may provide an 'id' base reference plus overrides.

fontScheme.json

{
  "fontScheme": "aptos"
}

`background`

typeref:BackgroundShortcut | ref:Backgroundrequirednodefault—

Default background for this theme. String shorthand accepts theme slots ('light1', 'light2', 'dark1', 'dark2') or hex colors.

background.json

{
  "background": "dark1"
}

`dimensions`

typeref:DimensionPreset | ref:Dimensionsrequirednodefault—

Default slide size for this theme. A string preset is equivalent to { preset: value }.

dimensions.json

{
  "dimensions": "widescreen"
}

`tags`

typearray<string>requirednodefault—

Free-form labels for filtering and search.

tags.json

{
  "tags": []
}