pantoken-root / platforms/canvas-theme-editor/src / BuildThemeOptions

Interface: BuildThemeOptions ​

Alpha

Options for buildTheme/buildThemeCss/buildThemeJs.

Properties ​

provider? ​

optional provider?: string | CdnProvider

Alpha

The CDN provider to build URLs for. Defaults to jsDelivr when omitted.

version? ​

optional version?: string

Alpha

Pins the version for every asset below that doesn't specify its own version.

theme? ​

optional theme?: ThemeVariant

Alpha

Token theme variant. Defaults to "rebrand". Ignored when css is supplied.

mode? ​

optional mode?: ThemeMode

Alpha

Rebrand token mode. Defaults to "light". Ignored outside the rebrand theme, or when css is supplied.

css? ​

optional css?: readonly CdnFile[]

Alpha

Component-style sheets. Defaults to defaultThemeCssAssets for theme/mode.

scoped? ​

optional scoped?: boolean

Alpha

Ship the multi-scope token pair instead of a single baked theme, so several themes and colour schemes can be active in one Canvas page. Larger; only worth it when that's actually needed.

fonts? ​

optional fonts?: readonly CdnFile[]

Alpha

Font sheet(s). Defaults to DEFAULT_THEME_FONT_ASSETS.

js? ​

optional js?: readonly CdnFile[]

Alpha

Script(s). Defaults to DEFAULT_THEME_JS_ASSETS.

strings? ​

optional strings?: Partial<ThemeStrings>

Alpha

Translated comment strings. Defaults to ENGLISH_THEME_STRINGS.