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

# Styles & Modifiers

Styles combine a foreground color, background color, and text modifiers into a single composable unit.

## OpalineStyle

The core style type:

```rust
use opaline::OpalineStyle;

// Foreground only
let style = OpalineStyle::fg(OpalineColor::new(225, 53, 255));

// With modifiers
let bold_keyword = OpalineStyle::fg(OpalineColor::new(225, 53, 255)).bold();

// Full builder
let fancy = OpalineStyle::new()
    .with_fg(OpalineColor::new(225, 53, 255))
    .with_bg(OpalineColor::new(18, 18, 24))
    .bold()
    .italic();
```

## Modifiers

Opaline supports all 9 terminal text modifiers:

| Modifier          | Method             | TOML Key               |
| ----------------- | ------------------ | ---------------------- |
| **Bold**          | `.bold()`          | `bold = true`          |
| **Italic**        | `.italic()`        | `italic = true`        |
| **Underline**     | `.underline()`     | `underline = true`     |
| **Dim**           | `.dim()`           | `dim = true`           |
| **Crossed Out**   | `.crossed_out()`   | `crossed_out = true`   |
| **Reversed**      | `.reversed()`      | `reversed = true`      |
| **Hidden**        | `.hidden()`        | `hidden = true`        |
| **Rapid Blink**   | `.rapid_blink()`   | `rapid_blink = true`   |
| **Slow Blink**    | `.slow_blink()`    | `slow_blink = true`    |

## Defining Styles in TOML

Styles reference tokens for their colors:

```toml
[styles]
keyword = { fg = "accent.primary", bold = true }
selected = { fg = "accent.secondary", bg = "bg.highlight" }
error_style = { fg = "error", bold = true, underline = true }
dimmed = { fg = "text.dim" }
inline_code = { fg = "success", bg = "bg.code" }
```

## Required Styles

Every builtin theme must define these 13 styles:

| Style              | Purpose                |
| ------------------ | ---------------------- |
| `keyword`          | Language keywords      |
| `line_number`      | Code line numbers      |
| `selected`         | Selected item          |
| `active_selected`  | Active + selected item |
| `focused_border`   | Focused panel border   |
| `unfocused_border` | Unfocused panel border |
| `success_style`    | Success state          |
| `error_style`      | Error state            |
| `warning_style`    | Warning state          |
| `info_style`       | Info state             |
| `dimmed`           | Dimmed/subtle text     |
| `muted`            | Muted text             |
| `inline_code`      | Inline code snippets   |

Domain-specific styles such as git status colors, diff styles, timestamps, authors, and mode indicators should be derived by consuming apps rather than required by Opaline core.

## Accessing Styles

```rust
let theme = opaline::Theme::default();

// Get a style (returns Default if missing)
let kw = theme.style("keyword");
assert!(kw.bold);

// Strict lookup
if let Some(style) = theme.try_style("keyword") {
    // ...
}

// Check existence
assert!(theme.has_style("keyword"));

// List all style names
let names = theme.style_names();
```

## Merging Styles

Styles can be merged. The overlay's non-default fields override the base:

```rust
let base = OpalineStyle::fg(OpalineColor::new(255, 255, 255));
let overlay = OpalineStyle::new().bold().italic();
let merged = base.merge(&overlay);

// merged has fg from base + bold/italic from overlay
```

This is useful for building compound styles from simpler components.