{}OPF
DocsObject referenceEdit on GitHub

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

Fields

FieldTypeReqDescription
idstringTheme 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…
namestringHuman-readable theme name shown in pickers.
summarystringOne-sentence positioning of the theme - when to reach for it.
descriptionstringLonger prose describing what the theme looks and feels like and the kinds of decks it suits.
colorSchemestring | ref:ColorSchemeDefault color scheme for this theme. A string resolves against catalogs.colorSchemes; an object may provide an 'id' base reference plus overrides.
fontSchemestring | ref:FontSchemeDefault font scheme for this theme. A string resolves against catalogs.fontSchemes; an object may provide an 'id' base reference plus overrides.
backgroundref:BackgroundShortcut | ref:BackgroundDefault background for this theme. String shorthand accepts theme slots ('light1', 'light2', 'dark1', 'dark2') or hex colors.
dimensionsref:DimensionPreset | ref:DimensionsDefault slide size for this theme. A string preset is equivalent to { preset: value }.
tagsarray<string>Free-form labels for filtering and search.

id

Type: string · Optional · Default:

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

Type: string · Optional · Default:

Human-readable theme name shown in pickers.

name.json
{
  "name": "Minimal"
}

summary

Type: string · Optional · Default:

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

summary.json
{
  "summary": "summary-value"
}

description

Type: string · Optional · Default:

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

description.json
{
  "description": "description-value"
}

colorScheme

Type: string | ref:ColorScheme · Optional · Default:

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

Type: string | ref:FontScheme · Optional · Default:

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

Type: ref:BackgroundShortcut | ref:Background · Optional · Default:

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

background.json
{
  "background": "dark1"
}

dimensions

Type: ref:DimensionPreset | ref:Dimensions · Optional · Default:

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

dimensions.json
{
  "dimensions": "widescreen"
}

tags

Type: array<string> · Optional · Default:

Free-form labels for filtering and search.

tags.json
{
  "tags": []
}