native-theme

What it does

Cross-platform theme data model with 24 semantic color roles, 26 per-widget themes, and 16 bundled TOML presets. Reads OS themes from KDE Plasma, GNOME (via xdg-desktop-portal), macOS, and Windows, and produces a fully populated ResolvedTheme any GUI toolkit can consume.

How it fits

Most apps don't depend on this crate directly — they use a framework connector like native-theme-gpui, native-theme-iced or native-theme-egui, which pull native-theme in transitively. Depend on native-theme directly only if you are writing a new connector.

Quick start

Add the dependency:

cargo add native-theme

Read the live OS theme:

use native_theme::SystemTheme;

let sys = SystemTheme::from_system()?;
let active = sys.pick(sys.mode);                 // &ResolvedTheme
let accent = active.defaults.accent_color;       // Rgba (fully populated)
let bg     = active.defaults.background_color;   // Rgba
# Ok::<(), native_theme::error::Error>(())

For OS readers, enable the native feature (or an individual kde / portal / macos / windows) — see Feature flags below. No features are needed to use bundled presets.

Core concepts

• Theme — sparse, TOML-shaped definition (fields are Option<T>). Load via Theme::preset(…), Theme::from_toml(…), or Theme::from_file(…).

• ResolvedTheme — resolved variant: every font has a value, and so does every colour but 29 optional ones, most of them state shades such as checkbox.hover_background, which every bundled preset states and a theme of your own may leave None. Every size the model requires has a value too; the sizes it treats as optional (padding sides, menu and list row heights, toolbar height and item gap, tab item gap and active-indicator width, combobox arrow width, expander arrow gap and content indent, the checkbox's radio indicator width, radio dot diameter and check-mark stroke width, the switch's unchecked thumb diameter) are None where the theme states none, and the toolkit's own value then applies; so are expander.arrow_side, expander.frame_enabled and tab.active_indicator_side. Safe to hand to UI code.

• ColorMode — the Light / Dark choice passed when resolving.

• Preset — a named bundled theme. 16 ship today:

  • Platform: kde-breeze, adwaita, windows-11, macos-sonoma, material, ios
  • Community: catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, nord, dracula, gruvbox, solarized, tokyo-night, one-dark

  Enumerate with Theme::list_presets() or Theme::list_presets_for_platform().

Common recipes

Load a bundled preset

use native_theme::theme::{ColorMode, Theme};

let theme = Theme::preset("catppuccin-mocha")?;
let resolved = theme.resolve(ColorMode::Dark)?;
let accent = resolved.variant.defaults.accent_color;  // Rgba
# Ok::<(), native_theme::error::Error>(())

theme.resolve(mode) returns a Resolved wrapper containing variant (the ResolvedTheme) plus the effective icon-set and icon-theme metadata.

Layer user overrides on a preset

use native_theme::theme::Theme;

let mut theme = Theme::preset("nord")?;
let overrides = Theme::from_toml(r##"
    name = "My Nord"
    [light.defaults]
    accent_color = "#ff6600"
"##)?;
theme.merge(&overrides);
# Ok::<(), native_theme::error::Error>(())

merge fills in only the fields present in the overlay; everything else stays from the base preset.

Apply an overlay to the OS theme at runtime

use native_theme::{SystemTheme, theme::Theme};

let sys = SystemTheme::from_system()?;
let overlay = Theme::from_toml(r##"
    [light.defaults]
    accent_color = "#ff6600"
"##)?;
let customised = sys.with_overlay(&overlay)?;
# Ok::<(), native_theme::error::Error>(())

Cheap dark-mode poll

use native_theme::detect::system_is_dark;

if system_is_dark() {
    // …
}

Cached, does not run the full theme-reader pipeline.

Icon sets

Semantic icon roles map to platform-appropriate glyphs via typed per-set loaders:

use native_theme::icons::{MaterialLoader, FreedesktopLoader};
use native_theme::theme::IconRole;

// Bundled set (no system dependencies).
let copy = MaterialLoader::new(IconRole::ActionCopy).load();

// System icon theme on Linux (reads the active theme, e.g. breeze-dark).
let sys = FreedesktopLoader::new(IconRole::ActionCopy)
    .theme("breeze-dark")
    .load();

Animated spinners respect the OS prefers-reduced-motion preference:

use native_theme::icons::MaterialLoader;
use native_theme::detect::prefers_reduced_motion;

if let Some(anim) = MaterialLoader::load_indicator() {
    if prefers_reduced_motion() {
        let _static_fallback = anim.first_frame();
    } else {
        // Play the animation — AnimatedIcon has Frames and Transform variants.
    }
}

Connector crates provide toolkit playback helpers (see the native-theme-gpui and native-theme-iced READMEs, and native-theme-egui's icons::animated_frame_index and icons::spin_angle).

Feature flags

[dependencies]
native-theme = { version = "0.6", features = ["native"] }

native is a meta-feature enabling every OS reader for the current target (kde + portal + macos + windows). Individual features:

OS-specific dependencies are target-gated — native on macOS only pulls in macOS-related deps.

Links

• API reference on docs.rs
• Connectors: native-theme-gpui, native-theme-iced, native-theme-egui
• Showcase examples
• CHANGELOG

License

Licensed under any of

• Apache License, Version 2.0
• MIT License
• 0BSD License

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be triple licensed as above, without any additional terms or conditions.