getThemeInfo

Updated:

Returns the active theme name and aesthetic.

Description

Retrieves the active theme name and aesthetic from the platform.

Signature

tecton.sources.getThemeInfo(): Promise<ThemeInfo>;
export interface ThemeInfo {
    themeName: string;
    aesthetic: string|null;
}

Usage

Get theme info from Tecton sources

const themeInfo = await tecton.sources.getThemeInfo?.();
console.log(themeInfo?.themeName, themeInfo?.aesthetic);

Additional Information

When using the getThemeInfo source, there are important details to keep in mind.

Feature Detection

getThemeInfo may not exist in older platform environments. Even if your extension is built against a newer Tecton SDK, the host UUX version it runs in may not advertise the capability and it will return undefined. When the capability is not available, your extension can fall back to getCurrentTheme, which remains supported in older environments. Note that the data shapes differ: getThemeInfo returns { themeName, aesthetic }, while getCurrentTheme returns the CSS file path of the active theme. The aesthetic value has no equivalent in older platforms.

Platform Support

UUX

Changelog

The changelog provides a detailed history of new features, improvements, and bug fixes going back to Tecton 1.30.0. If the button is disabled, it indicates there have been no detectable changes since then.

Show changelog (1)