Struct ThemeManager 

pub struct ThemeManager { /* private fields */ }

The theme registry and the active selection, installed as a gpui global alongside Theme itself. See the module docs.

Implementations

impl ThemeManager

pub fn new() -> Self

A registry holding just light and dark, following the system.

Those two ids are the light/dark pair ThemeChoice::System resolves through, so an app with its own two-theme identity can re-register them (same ids, its own themes and names) and get the follow behaviour for free. To use a different pair, see ThemeManager::pair.

pub fn with_presets(self) -> Self

Add the six prebuilt presets (see PRESET_NAMES).

pub fn with(self, entry: ThemeEntry) -> Self

Add one theme (builder form of ThemeManager::register).

pub fn with_dir(self, dir: impl AsRef<Path>) -> Self

Load a directory of *.json theme files, ignoring the ones that fail. Use ThemeManager::load_dir when you want to report them.

pub fn choice(self, choice: ThemeChoice) -> Self

Set the choice (builder form of ThemeManager::set_choice).

pub fn pair( self, light: impl Into<SharedString>, dark: impl Into<SharedString>, ) -> Self

Point ThemeChoice::System at a different pair of registered themes.

pub fn register(&mut self, entry: ThemeEntry)

Add a theme, replacing any entry with the same id.

pub fn register_json( &mut self, id: impl Into<SharedString>, source: &str, ) -> Result<(), ThemeJsonError>

Register a theme from JSON the host already has in hand — an include_str!, a downloaded file, a string from its own config.

pub fn load_dir(&mut self, dir: impl AsRef<Path>) -> Vec<ThemeLoadError>

Load every *.json file in dir as a theme, keyed by file stem, and return the files that failed. A missing directory is not an error — apps point this at a folder the user may never create.

pub fn entries(&self) -> &[ThemeEntry]

Every registered theme, in registration order.

pub fn entry(&self, id: &str) -> Option<&ThemeEntry>

pub fn selection(&self) -> &ThemeChoice

The active choice. Persist it with to_string().

pub fn system_scheme(&self) -> ColorScheme

The last OS appearance a watched window reported.

pub fn resolved(&self) -> &ThemeEntry

The entry the current choice resolves to. Falls back to the light/dark pair, then to the first entry, so a stale id in a config file degrades to a sane theme instead of a panic.

pub fn resolved_id(&self) -> &SharedString

The id of the theme currently in use.

pub fn install(self, cx: &mut App)

Install as the global and apply the resolved theme.

pub fn apply(cx: &mut App)

Write the resolved theme into the Theme global and redraw. Every mutator below ends here; call it directly after editing the manager through cx.global_mut::<ThemeManager>().

pub fn select(cx: &mut App, id: impl Into<SharedString>) -> bool

Wear one registered theme. Unknown ids are ignored (and reported as false) so a picker can’t strand the app on a theme that isn’t there.

pub fn follow_system(cx: &mut App)

Follow the OS appearance again.

pub fn set_choice(cx: &mut App, choice: ThemeChoice)

Set the choice and apply it.

pub fn toggle(cx: &mut App)

Swap to the light/dark counterpart of what is showing — what a light/dark toggle button does. Leaves ThemeChoice::System: an explicit toggle is an explicit choice.

pub fn set_system_scheme(cx: &mut App, scheme: ColorScheme)

Record the OS appearance, restyling if the choice follows it. Usually driven by ThemeManager::watch; call it directly when the host learns the appearance some other way.

pub fn watch(window: &mut Window, cx: &mut App)

Track a window’s appearance, so ThemeChoice::System follows the OS. Call once per window, from the window’s init. The subscription is held by the manager global, which outlives every window.

Trait Implementations

impl Debug for ThemeManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThemeManager

fn default() -> Self

Returns the “default value” for a type.

impl Global for ThemeManager