gleamtea/style

A composable styling layer, inspired by charmbracelet/lipgloss. New in beamtea 0.1.2.

Build a Style by piping setters from new, then render it onto text. A style bundles inline attributes (colour, bold, …) with block layout (width, alignment, padding, border, margin):

import gleamtea/style
import gleamtea/color

style.new()
|> style.foreground(style.Named(color.Charmple))
|> style.bold
|> style.padding(style.VH(0, 2))
|> style.border(style.Rounded)
|> style.border_foreground(style.Named(color.Purple))
|> style.render("Hello")

Types

Border

</>

A border style.

pub type Border {
  NoBorder
  Normal
  Rounded
  Thick
  Double
}

Constructors

```
NoBorder
```
```
Normal
```
```
Rounded
```
```
Thick
```
```
Double
```

Spacing

</>

Box spacing for padding / margin: the same value on all sides, a vertical/horizontal pair, or explicit top/right/bottom/left.

pub type Spacing {
  All(Int)
  VH(vertical: Int, horizontal: Int)
  Sides(top: Int, right: Int, bottom: Int, left: Int)
}

Constructors

```
All(Int)
```
```
VH(vertical: Int, horizontal: Int)
```

Sides(top: Int, right: Int, bottom: Int, left: Int)

Style

</>

An opaque style (a beamtea_style map).

pub type Style

StyleColor

</>

A colour a style can use: a named palette colour, a raw xterm-256 index, or a 24-bit truecolor triple.

pub type StyleColor {
  Named(color.Color)
  Index(Int)
  Rgb(r: Int, g: Int, b: Int)
}

Constructors

```
Named(color.Color)
```
```
Index(Int)
```
```
Rgb(r: Int, g: Int, b: Int)
```

Values

align

</>

pub fn align(style: Style, a: layout.HAlign) -> Style

Horizontally align content within its fixed width.

background

</>

pub fn background(style: Style, color: StyleColor) -> Style

Set the background colour.

bold

</>

pub fn bold(style: Style) -> Style

Make text bold.

border

</>

pub fn border(style: Style, b: Border) -> Style

Draw a border around the content.

border_foreground

</>

pub fn border_foreground(
  style: Style,
  color: StyleColor,
) -> Style

Colour the border.

faint

</>

pub fn faint(style: Style) -> Style

Make text faint/dim.

foreground

</>

pub fn foreground(style: Style, color: StyleColor) -> Style

Set the foreground colour.

height

</>

pub fn height(style: Style, h: Int) -> Style

Fix the content height (rows), padded/truncated per the vertical alignment.

italic

</>

pub fn italic(style: Style) -> Style

Make text italic.

join_horizontal

</>

pub fn join_horizontal(
  valign: layout.VAlign,
  blocks: List(String),
) -> String

Place already-rendered blocks side by side, aligning their differing heights.

join_vertical

</>

pub fn join_vertical(
  halign: layout.HAlign,
  blocks: List(String),
) -> String

Stack already-rendered blocks, aligning their differing widths.

margin

</>

pub fn margin(style: Style, spec: Spacing) -> Style

Outer spacing.

merge

</>

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

Layer over on top of base (over’s properties win).

new

</>

pub fn new() -> Style

An empty style.

padding

</>

pub fn padding(style: Style, spec: Spacing) -> Style

Inner spacing.

render

</>

pub fn render(style: Style, text: String) -> String

Apply the style to text, returning styled (possibly multi-line) output.

reverse

</>

pub fn reverse(style: Style) -> Style

Reverse foreground/background.

underline

</>

pub fn underline(style: Style) -> Style

Underline text.

valign

</>

pub fn valign(style: Style, v: layout.VAlign) -> Style

Vertically align content within its fixed height.

width

</>

pub fn width(style: Style, w: Int) -> Style

Fix the content width (columns); shorter lines are padded per the alignment, longer ones truncated.