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

//! String constants for the standard theme contract.
//!
//! Every builtin theme defines these tokens, styles, and gradients.
//! Use these instead of raw strings for autocomplete and typo prevention.
//!
//! ```rust
//! use opaline::{Theme, names::tokens, names::styles};
//!
//! let theme = Theme::default();
//! let accent = theme.color(tokens::ACCENT_PRIMARY);
//! let kw = theme.style(styles::KEYWORD);
//! ```

/// Semantic color token names (26 required).
pub mod tokens {
    pub const TEXT_PRIMARY: &str = "text.primary";
    pub const TEXT_SECONDARY: &str = "text.secondary";
    pub const TEXT_MUTED: &str = "text.muted";
    pub const TEXT_DIM: &str = "text.dim";

    pub const BG_BASE: &str = "bg.base";
    pub const BG_PANEL: &str = "bg.panel";
    pub const BG_CODE: &str = "bg.code";
    pub const BG_HIGHLIGHT: &str = "bg.highlight";
    pub const BG_SELECTION: &str = "bg.selection";

    pub const ACCENT_PRIMARY: &str = "accent.primary";
    pub const ACCENT_SECONDARY: &str = "accent.secondary";
    pub const ACCENT_TERTIARY: &str = "accent.tertiary";
    pub const ACCENT_DEEP: &str = "accent.deep";

    pub const SUCCESS: &str = "success";
    pub const ERROR: &str = "error";
    pub const WARNING: &str = "warning";
    pub const INFO: &str = "info";

    pub const BORDER_FOCUSED: &str = "border.focused";
    pub const BORDER_UNFOCUSED: &str = "border.unfocused";
    pub const CODE_KEYWORD: &str = "code.keyword";
    pub const CODE_FUNCTION: &str = "code.function";
    pub const CODE_STRING: &str = "code.string";
    pub const CODE_NUMBER: &str = "code.number";
    pub const CODE_COMMENT: &str = "code.comment";
    pub const CODE_TYPE: &str = "code.type";
    pub const CODE_LINE_NUMBER: &str = "code.line_number";
}

/// Named style constants (13 required).
pub mod styles {
    pub const KEYWORD: &str = "keyword";
    pub const LINE_NUMBER: &str = "line_number";
    pub const SELECTED: &str = "selected";
    pub const ACTIVE_SELECTED: &str = "active_selected";
    pub const FOCUSED_BORDER: &str = "focused_border";
    pub const UNFOCUSED_BORDER: &str = "unfocused_border";
    pub const SUCCESS_STYLE: &str = "success_style";
    pub const ERROR_STYLE: &str = "error_style";
    pub const WARNING_STYLE: &str = "warning_style";
    pub const INFO_STYLE: &str = "info_style";
    pub const DIMMED: &str = "dimmed";
    pub const MUTED: &str = "muted";
    pub const INLINE_CODE: &str = "inline_code";
}

/// Named gradient constants (5 required).
pub mod gradients {
    pub const PRIMARY: &str = "primary";
    pub const WARM: &str = "warm";
    pub const SUCCESS_GRADIENT: &str = "success_gradient";
    pub const ERROR_GRADIENT: &str = "error_gradient";
    pub const AURORA: &str = "aurora";
}