Struct Theme 

pub struct Theme {

    pub name: String,
    pub background: Option<Color>,
    pub surface: Option<Color>,
    pub foreground: Color,
    pub muted: Color,
    pub disabled: Color,
    pub border: Color,
    pub border_focused: Color,
    pub title: Color,
    pub primary: Color,
    pub secondary: Color,
    pub accent: Color,
    pub success: Color,
    pub warning: Color,
    pub error: Color,
    pub info: Color,
    pub selection_bg: Color,
    pub selection_fg: Color,
    pub highlight: Color,
    pub palette: Vec<Color>,
    pub bull: Color,
    pub bear: Color,
    pub neutral: Color,
    pub axis: Color,
    pub grid: Color,
    pub crosshair: Color,
    pub tooltip_fg: Color,
    pub tooltip_bg: Color,
}

A named set of colors shared by every widget of an application.

The first group of fields (foreground … highlight) is the general UI vocabulary; the second group (palette … tooltip_bg) are the data visualisation colors, kept under the same names tui-chart used so migrating is a rename of the import.

With the serde feature a theme (de)serialises as a flat map of "#rrggbb" / color-name strings; missing keys fall back to Theme::default, and unset background/surface are omitted.

Fields

name: String

Display name (also used by Theme::next / Theme::prev).

background: Option<Color>

Background fill; None keeps the terminal background.

surface: Option<Color>

Panel / card background; None means “same as background”.

foreground: Color

Default text color.

muted: Color

De-emphasised text (hints, tick labels, legends).

disabled: Color

Text of disabled elements.

border: Color

Unfocused border color.

border_focused: Color

Focused border color.

title: Color

Title color.

primary: Color

Main brand / interaction color.

secondary: Color

Secondary brand color.

accent: Color

Accent color (single-series charts, gradients, highlights).

success: Color

Positive status color.

warning: Color

Warning status color.

error: Color

Error status color.

info: Color

Informational status color.

selection_bg: Color

Background of the selected item.

selection_fg: Color

Foreground of the selected item.

highlight: Color

Highlight color (search matches, markers).

palette: Vec<Color>

Series palette (at least 8 colors); series i uses palette[i % len].

bull: Color

“Up” color (bullish candles, bids, increases).

bear: Color

“Down” color (bearish candles, asks, decreases).

neutral: Color

Neutral / total color.

axis: Color

Axis line color.

grid: Color

Grid line color.

crosshair: Color

Crosshair guide line color.

tooltip_fg: Color

Crosshair tooltip text color.

tooltip_bg: Color

Crosshair tooltip background color.

Implementations

impl Theme

pub fn catppuccin_mocha() -> Theme

Catppuccin Mocha (dark).

pub fn catppuccin_latte() -> Theme

Catppuccin Latte (light).

pub fn dracula() -> Theme

Dracula (dark).

pub fn nord() -> Theme

Nord (dark, arctic blues).

pub fn gruvbox() -> Theme

Gruvbox (dark, warm retro).

pub fn tokyo_night() -> Theme

Tokyo Night (dark).

pub fn solarized_dark() -> Theme

Solarized Dark.

pub fn solarized_light() -> Theme

Solarized Light.

pub fn one_dark() -> Theme

One Dark (Atom).

pub fn rose_pine() -> Theme

Rosé Pine (dark).

pub fn monokai() -> Theme

Monokai (dark).

pub fn default_light() -> Theme

Default Light (light, from gitkraft).

pub fn grape() -> Theme

Grape (dark, from gitkraft).

pub fn ocean() -> Theme

Ocean (dark, from gitkraft).

pub fn sunset() -> Theme

Sunset (dark, from gitkraft).

pub fn forest() -> Theme

Forest (dark, from gitkraft).

pub fn rose() -> Theme

Rose (dark, from gitkraft).

pub fn neon() -> Theme

Neon (dark, from gitkraft).

pub fn gruvbox_light() -> Theme

Gruvbox Light (light, from gitkraft).

pub fn catppuccin_frappe() -> Theme

Catppuccin Frappé (dark, from gitkraft).

pub fn catppuccin_macchiato() -> Theme

Catppuccin Macchiato (dark, from gitkraft).

pub fn tokyo_night_storm() -> Theme

Tokyo Night Storm (dark, from gitkraft).

pub fn tokyo_night_light() -> Theme

Tokyo Night Light (light, from gitkraft).

pub fn kanagawa_wave() -> Theme

Kanagawa Wave (dark, from gitkraft).

pub fn kanagawa_dragon() -> Theme

Kanagawa Dragon (dark, from gitkraft).

pub fn kanagawa_lotus() -> Theme

Kanagawa Lotus (light, from gitkraft).

pub fn moonfly() -> Theme

Moonfly (dark, from gitkraft).

pub fn nightfly() -> Theme

Nightfly (dark, from gitkraft).

pub fn oxocarbon() -> Theme

Oxocarbon (dark, from gitkraft).

pub fn cyberpunk() -> Theme

Cyberpunk (dark, from gitkraft).

pub fn rose_pine_moon() -> Theme

Rose Pine Moon (dark, from gitkraft).

pub fn rose_pine_dawn() -> Theme

Rose Pine Dawn (light, from gitkraft).

pub fn ayu_mirage() -> Theme

Ayu Mirage (dark, from gitkraft).

pub fn everforest_dark() -> Theme

Everforest Dark (dark, from gitkraft).

pub fn atom_one_light() -> Theme

Atom One Light (light, from gitkraft).

pub fn night_owl() -> Theme

Night Owl (dark, from gitkraft).

pub fn poimandres() -> Theme

Poimandres (dark, from gitkraft).

pub fn flexoki_dark() -> Theme

Flexoki Dark (dark, from gitkraft).

pub fn flexoki_light() -> Theme

Flexoki Light (light, from gitkraft).

pub fn carbonfox() -> Theme

Carbonfox (dark, from gitkraft).

pub fn andromeda() -> Theme

Andromeda (dark, from gitkraft).

pub fn synthwave() -> Theme

Synthwave (dark, from gitkraft).

pub fn ayu_dark() -> Theme

Ayu Dark.

pub fn github_dark() -> Theme

Github Dark.

pub fn github_light() -> Theme

Github Light.

pub fn zenburn() -> Theme

Zenburn.

pub fn super_mario() -> Theme

Super Mario.

pub fn tokyo_night_moon() -> Theme

Tokyo Night Moon.

pub fn tokyo_night_day() -> Theme

Tokyo Night Day.

pub fn gruvbox_material() -> Theme

Gruvbox Material.

pub fn nightfox() -> Theme

Nightfox.

pub fn dawnfox() -> Theme

Dawnfox.

pub fn melange() -> Theme

Melange.

pub fn material_palenight() -> Theme

Material Palenight.

pub fn tomorrow_night() -> Theme

Tomorrow Night.

pub fn snazzy() -> Theme

Snazzy.

pub fn iceberg() -> Theme

Iceberg.

pub fn papercolor_light() -> Theme

Papercolor Light.

pub fn synthwave_outrun() -> Theme

Synthwave Outrun.

pub fn cobalt() -> Theme

Cobalt.

pub fn modus_vivendi() -> Theme

Modus Vivendi.

pub fn modus_operandi() -> Theme

Modus Operandi.

pub fn horizon() -> Theme

Horizon.

pub fn sonokai() -> Theme

Sonokai.

pub fn clair_obscur() -> Theme

Clair Obscur.

pub fn clair_obscur_canvas() -> Theme

Clair Obscur Canvas.

pub fn mario_overworld() -> Theme

Mario Overworld.

pub fn mario_underground() -> Theme

Mario Underground.

pub fn pip_boy() -> Theme

Pip Boy.

pub fn tarnished() -> Theme

Tarnished.

pub fn hyrule() -> Theme

Hyrule.

pub fn doom() -> Theme

Doom.

pub fn phantom() -> Theme

Phantom.

pub fn cavern_hush() -> Theme

Cavern Hush.

pub fn test_chamber() -> Theme

Test Chamber.

pub fn ember() -> Theme

Ember.

pub fn meadow() -> Theme

Meadow.

pub fn dojo() -> Theme

Dojo.

pub fn underworld() -> Theme

Underworld.

pub fn summit() -> Theme

Summit.

pub fn rain_noir() -> Theme

Rain Noir.

pub fn blocky() -> Theme

Blocky.

pub fn everforest_light() -> Theme

Everforest Light.

pub fn ayu_light() -> Theme

Ayu Light.

pub fn duskfox() -> Theme

Duskfox.

impl Theme

pub fn porsche() -> Theme

Porsche: black/white with the signature red accent (#D5001C).

Bull is white and bear is red, as in the Porsche chart look.

pub fn colorblind() -> Theme

Colorblind-safe theme (Okabe–Ito palette; blue/orange instead of green/red). Keeps the terminal background.

pub fn high_contrast() -> Theme

Maximum-contrast theme: pure black/white with saturated status colors.

pub fn mono() -> Theme

Monochrome theme for 1-bit-ish terminals: only white, gray and dark gray, terminal background. Selection is shown in reverse video colors.

pub fn all() -> Vec<Theme>

All built-in themes, in cycling order.

pub fn names() -> Vec<&'static str>

Names of all built-in themes, in cycling order.

pub fn by_name(name: &str) -> Option<Theme>

Look a built-in theme up by name. Case-insensitive; _ and spaces are accepted for - ("Tokyo Night" → tokyo-night).

pub fn next(&self) -> Theme

The next built-in theme (wraps). Custom-named themes start at default.

pub fn prev(&self) -> Theme

The previous built-in theme (wraps). Custom-named themes start at the last one.

impl Theme

pub fn style(&self) -> Style

Base style: foreground (+ background when set).

pub fn base_style(&self) -> Style

Alias of Theme::style (the name tui-chart used).

pub fn surface_style(&self) -> Style

Style for panels / cards: foreground on surface (falls back to the background).

pub fn muted_style(&self) -> Style

De-emphasised text style.

pub fn border_style(&self, focused: bool) -> Style

Border style; the focused variant uses border_focused and bold.

pub fn title_style(&self) -> Style

Title style (bold).

pub fn selected_style(&self) -> Style

Style of the selected item: selection_fg on selection_bg.

pub fn disabled_style(&self) -> Style

Style of disabled elements.

pub fn highlight_style(&self) -> Style

Style of search matches / markers: highlight color, bold.

pub fn status_color(&self, status: Status) -> Color

Color for a Status.

pub fn status_style(&self, status: Status) -> Style

Style for a Status (its color as foreground).

pub fn axis_style(&self) -> Style

Axis line style.

pub fn label_style(&self) -> Style

Tick / legend label style (same color as muted).

pub fn grid_style(&self) -> Style

Grid line style.

pub fn tooltip_style(&self) -> Style

Tooltip style: tooltip_fg on tooltip_bg.

pub fn fill(&self, area: Rect, buf: &mut Buffer)

Fill area with the theme background (no-op when there is none).

impl Theme

pub fn downgrade(&self, support: ColorSupport) -> Theme

Reduce every color of the theme to what support can display.

TrueColor is a no-op, Ansi256 maps RGB to Color::Indexed, Ansi16 maps everything to the 16 named colors and None resets all colors (and clears background/surface) so the terminal default is used.

pub fn downgrade_for_terminal(&self) -> Theme

Theme::downgrade using ColorSupport::detect.

impl Theme

pub fn from_base( name: &str, background: Option<Color>, foreground: Color, accent: Color, bull: Color, bear: Color, ) -> Theme

Build a theme from the handful of colors an application already has.

Everything else is derived: RGB (and named/indexed) colors are blended between background (black when None) and foreground, so muted text, grid, borders, disabled text, surface and selection stay in tune. Success/bull use bull, error/bear use bear, primary/accent use accent; the palette starts with accent, bull, bear. Use the builder setters afterwards to fine-tune.

use ratatui::style::Color;
use tui_nuances::Theme;

let t = Theme::from_base(
    "app",
    Some(Color::Rgb(16, 16, 24)),
    Color::Rgb(230, 230, 240),
    Color::Rgb(213, 0, 28),
    Color::Green,
    Color::Red,
);
assert_eq!(t.primary, Color::Rgb(213, 0, 28));
assert!(t.palette.len() >= 8);

pub fn from_palette(name: &str, colors: &[Color]) -> Theme

Build a theme from just a series palette (terminal background, white text). The first three colors become accent / bull / bear; the palette is cycled up to at least 8 entries. An empty slice yields the default palette.

use ratatui::style::Color;
use tui_nuances::Theme;

let t = Theme::from_palette("pair", &[Color::Red, Color::Blue]);
assert_eq!(t.palette.len(), 8);
assert_eq!(t.color(2), Color::Red);

pub fn colors(&self) -> Vec<Color>

Every color of the theme (background and surface included when set, palette last). Handy for audits and tests.

pub fn name(self, name: impl Into<String>) -> Theme

Set the display name.

pub fn palette(self, palette: Vec<Color>) -> Theme

Set the series palette (an empty palette is ignored).

pub fn background(self, background: Option<Color>) -> Theme

Set (or clear) the background fill.

pub fn surface(self, surface: Option<Color>) -> Theme

Set (or clear) the panel / card background.

pub fn foreground(self, color: Color) -> Theme

Set the foreground color.

pub fn muted(self, color: Color) -> Theme

Set the muted color.

pub fn disabled(self, color: Color) -> Theme

Set the disabled color.

pub fn border(self, color: Color) -> Theme

Set the border color.

pub fn border_focused(self, color: Color) -> Theme

Set the border_focused color.

pub fn title(self, color: Color) -> Theme

Set the title color.

pub fn primary(self, color: Color) -> Theme

Set the primary color.

pub fn secondary(self, color: Color) -> Theme

Set the secondary color.

pub fn accent(self, color: Color) -> Theme

Set the accent color.

pub fn success(self, color: Color) -> Theme

Set the success color.

pub fn warning(self, color: Color) -> Theme

Set the warning color.

pub fn error(self, color: Color) -> Theme

Set the error color.

pub fn info(self, color: Color) -> Theme

Set the info color.

pub fn selection_bg(self, color: Color) -> Theme

Set the selection_bg color.

pub fn selection_fg(self, color: Color) -> Theme

Set the selection_fg color.

pub fn highlight(self, color: Color) -> Theme

Set the highlight color.

pub fn bull(self, color: Color) -> Theme

Set the bull color.

pub fn bear(self, color: Color) -> Theme

Set the bear color.

pub fn neutral(self, color: Color) -> Theme

Set the neutral color.

pub fn axis(self, color: Color) -> Theme

Set the axis color.

pub fn grid(self, color: Color) -> Theme

Set the grid color.

pub fn crosshair(self, color: Color) -> Theme

Set the crosshair color.

pub fn tooltip_fg(self, color: Color) -> Theme

Set the tooltip_fg color.

pub fn tooltip_bg(self, color: Color) -> Theme

Set the tooltip_bg color.

pub fn tooltip(self, fg: Color, bg: Color) -> Theme

Set the tooltip foreground/background colors.

pub fn selection(self, fg: Color, bg: Color) -> Theme

Set the selection foreground/background colors.

pub fn color(&self, i: usize) -> Color

Palette color for series i (cycles; falls back to accent if empty).

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Theme

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Theme

Terminal-native theme built from named ANSI colors only.

impl From<&Theme> for Theme

fn from(t: &Theme) -> Theme

Converts to this type from the input type.

impl PartialEq for Theme

fn eq(&self, other: &Theme) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Theme

impl ThemeProvider for Theme

fn nuance_theme(&self) -> Theme

Produce the shared Theme for this application theme.