etui/style

Types

Color

Terminal color. Default defers to the terminal theme. Indexed(n) covers the whole 256-color space: 0 to 15 are the themeable ANSI colors, 16 to 255 the extended palette (the 6x6x6 cube and the grayscale ramp). Rgb(r, g, b) uses 24-bit true color and needs a truecolor terminal.

pub type Color {
  Default
  Indexed(Int)
  Rgb(Int, Int, Int)
}

Constructors

```
Default
```
```
Indexed(Int)
```
```
Rgb(Int, Int, Int)
```

Modifier

opaque </>

Opaque bitfield for text modifiers. Use constants + add/remove/has.

pub opaque type Modifier

Style

</>

Combined foreground color, background color, and text modifiers.

pub type Style {
  Style(fg: Color, bg: Color, modifier: Modifier)
}

Constructors

Style(fg: Color, bg: Color, modifier: Modifier)

Values

add

</>

pub fn add(a: Modifier, b: Modifier) -> Modifier

Combine two modifiers (bitwise OR).

add_modifier

</>

pub fn add_modifier(s: Style, m: Modifier) -> Style

Add a modifier to a Style (bitwise OR).

ansi_bg

</>

pub fn ansi_bg(color: Color) -> String

Background color escape sequence.

ansi_fg

</>

pub fn ansi_fg(color: Color) -> String

Foreground color escape sequence.

ansi_modifier

</>

pub fn ansi_modifier(m: Modifier) -> String

Text modifier escape sequence. Emits all active modifier bits.

ansi_reset

</>

pub fn ansi_reset() -> String

Reset all styles.

blink

</>

pub fn blink() -> Modifier

Blinking text (terminal support varies).

bold

</>

pub fn bold() -> Modifier

Bold / increased intensity.

bold_style

</>

pub fn bold_style() -> Style

Default colors with bold modifier.

color_from_hex

</>

pub fn color_from_hex(hex: String) -> Result(Color, Nil)

Parse an RGB color from a hex string ("#RRGGBB" or "RRGGBB"). Returns Error(Nil) for malformed input.

style.color_from_hex("#1e1e2e")  // Ok(Rgb(30, 30, 46))
style.color_from_hex("ff5555")   // Ok(Rgb(255, 85, 85))

default_style

</>

pub fn default_style() -> Style

Default style: terminal colors, no modifiers.

dim

</>

pub fn dim() -> Modifier

Dim / decreased intensity.

dim_style

</>

pub fn dim_style() -> Style

Default colors with dim modifier.

has

</>

pub fn has(m: Modifier, flag: Modifier) -> Bool

Check if flag bits are set in m.

is_none

</>

pub fn is_none(m: Modifier) -> Bool

True when no modifier bits are set.

italic

</>

pub fn italic() -> Modifier

Italic text.

italic_style

</>

pub fn italic_style() -> Style

Default colors with italic modifier.

modifier_equal

</>

pub fn modifier_equal(a: Modifier, b: Modifier) -> Bool

Structural equality for modifiers.

none

</>

pub fn none() -> Modifier

No modifiers active.

patch

</>

pub fn patch(base: Style, over: Style) -> Style

Apply over on top of base. Default fg/bg fall back to base. Modifier: if over has any bits set, they are OR’d into base; none() in over means “no modifier override” (keep base).

remove

</>

pub fn remove(a: Modifier, b: Modifier) -> Modifier

Remove modifier bits from a that are set in b.

remove_modifier

</>

pub fn remove_modifier(s: Style, m: Modifier) -> Style

Remove modifier bits from a Style.

reverse

</>

pub fn reverse() -> Modifier

Swap foreground and background colors.

reversed

</>

pub fn reversed() -> Style

Default colors with reverse modifier (swap fg/bg).

strikethrough

</>

pub fn strikethrough() -> Modifier

Strikethrough.

underline

</>

pub fn underline() -> Modifier

Underline.

underline_style

</>

pub fn underline_style() -> Style

Default colors with underline modifier.

with_bg

</>

pub fn with_bg(s: Style, bg: Color) -> Style

Set background color on a style.

with_fg

</>

pub fn with_fg(s: Style, fg: Color) -> Style

Set foreground color on a style.

with_modifier

</>

pub fn with_modifier(s: Style, m: Modifier) -> Style

Set modifier on a style.