etch/style

This module provides utilities for styling terminal text.

Types

Attribute

A type that represents text attributes like bold, italic, etc.

pub type Attribute {
  Bold
  Dim
  Underline
  Italic
  Blinking
  Inverse
}

Constructors

```
Bold
```
Bold text.
```
Dim
```
Dim text.
```
Underline
```
Underline text.
```
Italic
```
Italic text.
```
Blinking
```
Blinking text.
```
Inverse
```
Inverse (swaps foreground and background Colors).

Color

</>

A type that represents a color that can be set as foreground or background.

pub type Color {
  Default
  Black
  Grey
  Red
  BrightRed
  Green
  BrightGreen
  Yellow
  BrightYellow
  Blue
  BrightBlue
  Magenta
  BrightMagenta
  Cyan
  BrightCyan
  White
  BrightWhite
  BrightGrey
  AnsiValue(v: Int)
  Rgb(r: Int, g: Int, b: Int)
}

Constructors

```
Default
```
Default terminal color.
```
Black
```
Black color.
```
Grey
```
Grey color.
```
Red
```
Red color.
```
BrightRed
```
Bright red color.
```
Green
```
Green color.
```
BrightGreen
```
Bright green color.
```
Yellow
```
Yellow color.
```
BrightYellow
```
Bright yellow color.
```
Blue
```
Blue color.
```
BrightBlue
```
Bright blue color.
```
Magenta
```
Magenta color.
```
BrightMagenta
```
Bright magenta color.
```
Cyan
```
Cyan color.
```
BrightCyan
```
Bright cyan color.
```
White
```
White color.
```
BrightWhite
```
Bright white color.
```
BrightGrey
```
Bright grey color.
```
AnsiValue(v: Int)
```
Ansi color (256 colors). See https://www.ditig.com/256-colors-cheat-sheet.
```
Rgb(r: Int, g: Int, b: Int)
```
RGB color.

Style

</>

Allows to save style (foreground and background Colors) and Attributes) and use it later by calling with_style.

pub type Style {
  Style(bg: Color, fg: Color, attributes: List(Attribute))
}

Constructors

```
Style(bg: Color, fg: Color, attributes: List(Attribute))
```
Arguments

bg

A background Color.

fg

A foreground Color.

attributes

Attributes.

Values

ansi

</>

pub fn ansi(s: String, value: Int) -> String

Sets the foreground Color to the given ANSI value and resets it afterwards.

black

</>

pub fn black(s: String) -> String

Sets the foreground Color to black and resets the color afterwards.

blinking

</>

pub fn blinking(s: String) -> String

Makes the string blinking and resets this attribute afterwards.

blue

</>

pub fn blue(s: String) -> String

Sets the foreground Color to blue and resets the color afterwards.

bold

</>

pub fn bold(s: String) -> String

Makes the string bold and resets this attribute afterwards.

bright_blue

</>

pub fn bright_blue(s: String) -> String

Sets the foreground Color to bright blue and resets the color afterwards.

bright_cyan

</>

pub fn bright_cyan(s: String) -> String

Sets the foreground Color to bright cyan and resets the color afterwards.

bright_green

</>

pub fn bright_green(s: String) -> String

Sets the foreground Color to bright green and resets the color afterwards.

bright_grey

</>

pub fn bright_grey(s: String) -> String

Sets the foreground Color to bright grey and resets the color afterwards.

bright_magenta

</>

pub fn bright_magenta(s: String) -> String

Sets the foreground Color to bright magenta and resets the color afterwards.

bright_red

</>

pub fn bright_red(s: String) -> String

Sets the foreground Color to bright red and resets the color afterwards.

bright_white

</>

pub fn bright_white(s: String) -> String

Sets the foreground Color to bright white and resets the color afterwards.

bright_yellow

</>

pub fn bright_yellow(s: String) -> String

Sets the foreground Color to bright yellow and resets the color afterwards.

cyan

</>

pub fn cyan(s: String) -> String

Sets the foreground Color to cyan and resets the color afterwards.

default_style

</>

pub fn default_style() -> Style

Returns default Style with terminal’s default foreground and background Colors) and no Attributes.

dim

</>

pub fn dim(s: String) -> String

Makes the string dim and resets this attribute afterwards.

green

</>

pub fn green(s: String) -> String

Sets the foreground Color to green and resets the color afterwards.

grey

</>

pub fn grey(s: String) -> String

Sets the foreground Color to grey and resets the color afterwards.

inverse

</>

pub fn inverse(s: String) -> String

Makes the string inverse (swaps background and foreground colors) and resets this attribute afterwards. See Color.

italic

</>

pub fn italic(s: String) -> String

Makes the string italic and resets this attribute afterwards.

magenta

</>

pub fn magenta(s: String) -> String

Sets the foreground Color to magenta and resets the color afterwards.

on

</>

pub fn on(s: String, c: Color) -> String

Sets the foreground color of a string. It does not reset the color after applying it. Also see with to set the foreground color. Using with_on is prefered to set both the background and foreground colors.

on_ansi

</>

pub fn on_ansi(s: String, value: Int) -> String

Sets the background Color to the given ANSI value and resets it afterwards.

on_black

</>

pub fn on_black(s: String) -> String

Sets the background Color to black and resets it afterwards.

on_blue

</>

pub fn on_blue(s: String) -> String

Sets the background Color to blue and resets it afterwards.

on_bright_blue

</>

pub fn on_bright_blue(s: String) -> String

Sets the background Color to bright blue and resets it afterwards.

on_bright_cyan

</>

pub fn on_bright_cyan(s: String) -> String

Sets the background Color to bright cyan and resets it afterwards.

on_bright_green

</>

pub fn on_bright_green(s: String) -> String

Sets the background Color to bright green and resets it afterwards.

on_bright_grey

</>

pub fn on_bright_grey(s: String) -> String

Sets the background Color to bright grey and resets it afterwards.

on_bright_magenta

</>

pub fn on_bright_magenta(s: String) -> String

Sets the background Color to bright magenta and resets it afterwards.

on_bright_red

</>

pub fn on_bright_red(s: String) -> String

Sets the background Color to bright red and resets it afterwards.

on_bright_white

</>

pub fn on_bright_white(s: String) -> String

Sets the background Color to bright white and resets it afterwards.

on_bright_yellow

</>

pub fn on_bright_yellow(s: String) -> String

Sets the background Color to bright yellow and resets it afterwards.

on_cyan

</>

pub fn on_cyan(s: String) -> String

Sets the background Color to cyan and resets it afterwards.

on_green

</>

pub fn on_green(s: String) -> String

Sets the background Color to green and resets it afterwards.

on_grey

</>

pub fn on_grey(s: String) -> String

Sets the background Color to grey and resets it afterwards.

on_magenta

</>

pub fn on_magenta(s: String) -> String

Sets the background Color to magenta and resets it afterwards.

on_rbg

</>

pub fn on_rbg(s: String, r: Int, g: Int, b: Int) -> String

Sets the background Color to the given RBG color and resets it afterwards.

on_red

</>

pub fn on_red(s: String) -> String

Sets the background Color to red and resets it afterwards.

on_white

</>

pub fn on_white(s: String) -> String

Sets the background Color to white and resets it afterwards.

on_yellow

</>

pub fn on_yellow(s: String) -> String

Sets the background Color to yellow and resets it afterwards.

rbg

</>

pub fn rbg(s: String, r: Int, g: Int, b: Int) -> String

Sets the foreground Color to the given RBG color and resets it afterwards.

red

</>

pub fn red(s: String) -> String

Sets the foreground Color to red and resets the color afterwards.

reset_attributes

</>

pub fn reset_attributes(s: String) -> String

Resets Attributes of the string.

reset_background

</>

pub fn reset_background(s: String) -> String

Resets background of the string. See Color.

reset_color

</>

pub fn reset_color(s: String) -> String

Resets color of the string. See Color.

reset_foreground

</>

pub fn reset_foreground(s: String) -> String

Resets foreground of the string. See Color.

reset_style

</>

pub fn reset_style(s: String) -> String

Resets color of the string. See Color.

set_style

</>

pub fn set_style(s: Style) -> String

Resets color of the string. See Color.

underline

</>

pub fn underline(s: String) -> String

Makes the string underline and resets this attribute afterwards.

white

</>

pub fn white(s: String) -> String

Sets the foreground Color to white and resets the color afterwards.

with

</>

pub fn with(s: String, c: Color) -> String

Sets the foreground color of a string. It does not reset the color after applying it. Also see on to set the background color. Using with_on is prefered to set both the background and foreground colors.

with_on

</>

pub fn with_on(s: String, fg: Color, bg: Color) -> String

Sets both the foreground and background colors. It is the prefered way to set them both for one string. Also see with to set the foreground color and on to set the background color.

with_style

</>

pub fn with_style(s: String, style: Style) -> String

Applies style to a string.

yellow

</>

pub fn yellow(s: String) -> String

Sets the foreground Color to yellow and resets the color afterwards.

Constructors

Constructors

Constructors

Arguments