opaline 0.4.1

A token-based theme engine for Rust applications
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! # Opaline
//!
//! A token-based theme engine for Rust applications.
//!
//! Opaline gives any Rust app TOML-driven themes with a three-layer resolution
//! pipeline: **palette** (raw hex colors) → **tokens** (semantic names) → **styles**
//! (composed fg/bg + modifiers). Themes can also define multi-stop **gradients**.
//!
//! Adapters are available for ratatui, egui, crossterm, owo-colors, syntect, and CSS.
//!
//! ## Quick start
//!
//! ```rust
//! use opaline::{Theme, OpalineColor};
//!
//! // Load the default builtin theme
//! let theme = Theme::default();
//!
//! // Access semantic tokens
//! let accent = theme.color("accent.primary");
//! let style = theme.style("keyword");
//! ```
//!
//! ## Features
//!
//! | Feature | Default | Description |
//! |---------|---------|-------------|
//! | `builtin-themes` | yes | 39 embedded TOML themes via `include_str!` |
//! | `gradients` | yes | Multi-stop gradient support |
//! | `ratatui` | yes | `From` impls for `ratatui::style::{Color, Style}` |
//! | `cli` | no | `colored` crate adapter for ANSI terminal output |
//! | `global-state` | no | Process-wide `current()`/`set_theme()` singleton |
//! | `discovery` | no | Load user themes from `~/.config/<app>/themes/` |

pub mod color;
pub mod error;
pub mod style;

#[cfg(feature = "gradients")]
pub mod gradient;

pub mod loader;
pub mod resolver;
pub mod schema;
pub mod theme;

pub mod adapters;
pub mod names;

#[cfg(feature = "builtin-themes")]
pub mod builtins;

#[cfg(feature = "discovery")]
pub mod discovery;

#[cfg(feature = "widgets")]
pub mod widgets;

// ── Re-exports ───────────────────────────────────────────────────────────

// Core types — always available
pub use color::{ColorParseError, OpalineColor};
pub use error::OpalineError;
pub use loader::{load_from_file, load_from_str};
pub use schema::{StyleDef, ThemeFile, ThemeMeta, ThemeVariant};
pub use style::OpalineStyle;
pub use theme::{Theme, ThemeBuilder};

// Gradients
#[cfg(feature = "gradients")]
pub use gradient::Gradient;

// Ratatui adapter
#[cfg(all(feature = "ratatui", feature = "gradients"))]
pub use adapters::ratatui::{gradient_bar, gradient_line, gradient_spans, gradient_text_line};

// CLI adapter
#[cfg(all(feature = "cli", feature = "gradients"))]
pub use adapters::cli::gradient_string;
#[cfg(feature = "cli")]
pub use adapters::cli::{ColoredExt, ThemeCliExt};

// CSS adapter
#[cfg(feature = "css")]
pub use adapters::css::{generate_css_classes, generate_css_vars, generate_stylesheet};

// owo-colors adapter
#[cfg(feature = "owo-colors")]
pub use adapters::owo_colors::OwoThemeExt;

// Global state
#[cfg(feature = "global-state")]
pub use theme::{current, load_theme, set_theme};
#[cfg(all(feature = "global-state", feature = "builtin-themes"))]
pub use theme::{load_theme_by_name, load_theme_by_name_with};
#[cfg(all(
    feature = "global-state",
    feature = "builtin-themes",
    feature = "discovery"
))]
pub use theme::{
    load_theme_by_name_for_app, load_theme_by_name_for_app_with, load_theme_by_name_in_dirs,
};

// Builtins
#[cfg(feature = "builtin-themes")]
pub use builtins::{ThemeInfo, list_available_themes, load_by_name};
#[cfg(all(feature = "builtin-themes", feature = "discovery"))]
pub use builtins::{list_available_themes_for_app, list_available_themes_in_dirs};

// Discovery
#[cfg(feature = "discovery")]
pub use discovery::{app_theme_dirs, theme_dirs};

// Widgets
#[cfg(feature = "widgets")]
pub use widgets::{ThemeSelector, ThemeSelectorAction, ThemeSelectorState};