ratkit 0.2.14

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

/// Theme variant module for light and dark mode support.
///
/// This module provides the [`ThemeVariant`] enum which represents whether
/// to use dark or light mode colors from a theme definition.
///
/// # Example
///
/// ```rust,ignore
/// use ratatui_toolkit::services::theme::ThemeVariant;
///
/// let variant = ThemeVariant::Dark;
/// assert_eq!(variant, ThemeVariant::Dark);
///
/// let light = ThemeVariant::Light;
/// assert_eq!(light, ThemeVariant::Light);
/// ```

/// Represents the color scheme variant for a theme.
///
/// Themes typically define two sets of colors - one optimized for dark
/// backgrounds and one for light backgrounds. This enum allows selecting
/// which set to use.
///
/// # Variants
///
/// * `Dark` - Use colors optimized for dark backgrounds (light text on dark)
/// * `Light` - Use colors optimized for light backgrounds (dark text on light)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum ThemeVariant {
    /// Dark mode colors - light text on dark background.
    ///
    /// This is typically the default for terminal applications.
    #[default]
    Dark,

    /// Light mode colors - dark text on light background.
    ///
    /// Suitable for terminals with light backgrounds or when
    /// matching a light system theme.
    Light,
}

/// Display trait implementation for [`ThemeVariant`].
use std::fmt;

impl fmt::Display for ThemeVariant {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ThemeVariant::Dark => write!(f, "dark"),
            ThemeVariant::Light => write!(f, "light"),
        }
    }
}