theme

README

lipgloss-theme

A lipgloss theme designed to give a consistent look and feel across all PurpleClay TUIs.

Dark

[Catppuccin Macchiato]

Light

[Catppuccin Latte]

Documentation

Overview

Package theme defines a set of lipgloss styles for ensuring any PurpleClay TUI is rendered with a consistent look and feel. All styles use an adaptive color palette for both light and dark terminal support

Index

• Variables
• type Table
  • func NewTable(data [][]string) *Table
  • func (t *Table) Border(border TableBorder) *Table
  • func (t *Table) Collapsed(on bool) *Table
  • func (t *Table) Dividers(on bool) *Table
  • func (t *Table) String() string
  • func (t *Table) Widths(w ...int) *Table
• type TableBorder

Variables

var (
	S950 = lipgloss.Color("#07000f")
	S900 = lipgloss.Color("#130027")
	S800 = lipgloss.Color("#1e003f")
	S700 = lipgloss.Color("#280057")
	S600 = lipgloss.Color("#33006f")
	S500 = lipgloss.Color("#3d0087")
	S400 = lipgloss.Color("#48009f")
	S300 = lipgloss.Color("#5712ab")
	S200 = lipgloss.Color("#6725b7")
	S100 = lipgloss.Color("#906ccf")
	S50  = lipgloss.Color("#a980db")
)

Defines the PurpleClay palette of color shades

var (
	Green900 = lipgloss.Color("#087331")
	Green700 = lipgloss.Color("#15803d")
	Amber900 = lipgloss.Color("#bf4102")
	Amber700 = lipgloss.Color("#db4b02")
	Red900   = lipgloss.Color("#ab0513")
	Red700   = lipgloss.Color("#db0f20")
)

Defines the PurpleClay palette for accent color shades

var (
	// A defines a PurpleClay themed hyperlink that supports both light and dark terminals
	A = lipgloss.NewStyle().
		Bold(true).
		Underline(true).
		Foreground(lipgloss.AdaptiveColor{
			Light: string(S400),
			Dark:  string(S100),
		})

	// H1 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H1 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S50),
			Dark:  string(S200),
		})

	// H2 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H2 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S100),
			Dark:  string(S300),
		})

	// H3 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H3 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S200),
			Dark:  string(S400),
		})

	// H4 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H4 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S300),
			Dark:  string(S500),
		})

	// H5 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H5 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S400),
			Dark:  string(S600),
		})

	// H6 defines a PurpleClay themed header that is ranked on importance from
	// H1 (most) to H6 (least). Supports both light and dark terminals
	H6 = h.
		Background(lipgloss.AdaptiveColor{
			Light: string(S500),
			Dark:  string(S700),
		})

	// Mark defines a PurpleClay themed text decoration for highlighting text. Supports
	// both light and dark terminals
	Mark = lipgloss.NewStyle().
			Padding(0, 1).
			Background(lipgloss.AdaptiveColor{
			Light: string(S50),
			Dark:  string(S700),
		})

	// I defines a PurpleClay themed hyperlink that supports both light and dark terminals
	I = lipgloss.NewStyle().Italic(true)

	// U defines a PurpleClay themed underline text decoration
	U = lipgloss.NewStyle().Underline(true)

	// B defines a PurpleClay themed bold text decoration
	B = lipgloss.NewStyle().Bold(true)

	// S defines a PurpleClay themed strikethrough text decoration
	S = lipgloss.NewStyle().Strikethrough(true)

	// Tick defines a PurpleClay themed glyph ✓ that supports both light and dark terminals
	Tick = lipgloss.NewStyle().
			Foreground(lipgloss.AdaptiveColor{
			Light: string(Green900),
			Dark:  string(Green700),
		}).
		Render("✓")

	// Cross defines a PurpleClay themed glyph x that supports both light and dark terminals
	Cross = lipgloss.NewStyle().
			Foreground(lipgloss.AdaptiveColor{
			Light: string(Red900),
			Dark:  string(Red700),
		}).
		Render("✕")

	// Bang defines a PurpleClay themed glyph ! that supports both light and dark terminals
	Bang = lipgloss.NewStyle().
			Foreground(lipgloss.AdaptiveColor{
			Light: string(Amber900),
			Dark:  string(Amber700),
		}).
		Render("!")

	// Logging defines a PurpleClay themed [logging] style that supports both light and
	// dark terminals
	//
	// [logging]: https://github.com/charmbracelet/log
	Logging = &log.Styles{
		Timestamp: lipgloss.NewStyle(),
		Caller:    lipgloss.NewStyle().Faint(true),
		Prefix:    lipgloss.NewStyle().Bold(true).Faint(true),
		Message:   lipgloss.NewStyle().MarginRight(2),
		Key: lipgloss.NewStyle().
			Foreground(lipgloss.AdaptiveColor{
				Light: string(S400),
				Dark:  string(S100),
			}),
		Value:     lipgloss.NewStyle(),
		Separator: lipgloss.NewStyle().Faint(true),
		Levels: map[log.Level]lipgloss.Style{
			log.DebugLevel: lipgloss.NewStyle().
				SetString(Tick).
				Bold(true).
				MaxWidth(2),
			log.InfoLevel: lipgloss.NewStyle().
				SetString(Tick).
				Bold(true).
				MaxWidth(2),
			log.WarnLevel: lipgloss.NewStyle().
				SetString(Bang).
				Bold(true).
				MaxWidth(2),
			log.ErrorLevel: lipgloss.NewStyle().
				SetString(Cross).
				Bold(true).
				MaxWidth(2),
			log.FatalLevel: lipgloss.NewStyle().
				SetString(Cross).
				Bold(true).
				MaxWidth(2),
		},
		Keys: map[string]lipgloss.Style{
			"err": lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{
				Light: string(Red900),
				Dark:  string(Red700),
			}),
			"error": lipgloss.NewStyle().Foreground(lipgloss.AdaptiveColor{
				Light: string(Red900),
				Dark:  string(Red700),
			}),
		},
		Values: map[string]lipgloss.Style{},
	}
)

var (

	// ThinBorder defines a series of characters for rendering a table with a thin border
	//
	// 	┌───────┬───────┬───────┐
	// 	│   1   │   2   │   3   │
	// 	├───────┼───────┼───────┤
	//	│   4   │   5   │   6   │
	// 	└───────┴───────┴───────┘
	ThinBorder = TableBorder{
		Bottom:      "─",
		BottomJoin:  "┴",
		BottomLeft:  "└",
		BottomRight: "┘",
		Middle:      "─",
		MiddleJoin:  "┼",
		MiddleLeft:  "├",
		MiddleRight: "┤",
		MiddleTop:   "┬",
		Top:         "─",
		TopJoin:     "┬",
		TopLeft:     "┌",
		TopRight:    "┐",
		Vertical:    "│",
	}

	// NoBorder should be used if rendering a table without a border
	NoBorder = TableBorder{}
)

Types

type Table

type Table struct {
	// contains filtered or unexported fields
}

Table supports the rendering of tabular data within a terminal

func NewTable

func NewTable(data [][]string) *Table

NewTable creates a table that will dynamically size around its provided data. By default the table will be rendered without any border

data := [][]string{
	{"City", "Avg. Rainfall", "Avg. Temp"},
	{"Barclona", "640 mm", "21.2 °C"},
	{"London", "585 mm", "11 °C"},
}
theme.NewTable(data)

func (*Table) Border

func (t *Table) Border(border TableBorder) *Table

Border sets the table border

func (*Table) Collapsed

func (t *Table) Collapsed(on bool) *Table

Collapsed controls whether all internal padding within the table should be removed

func (*Table) Dividers

func (t *Table) Dividers(on bool) *Table

Dividers controls whether a row divider should be rendered between all table rows

func (*Table) String

func (t *Table) String() string

String renders the table as a formatted string

func (*Table) Widths

func (t *Table) Widths(w ...int) *Table

Widths sets the maximum widths of each colum within the table. If only one argument is provided all columns will be fixed to the same width. If more than one argument is provided, each corresponding columns width will be fixed in turn.

type TableBorder

type TableBorder struct {
	Bottom      string
	BottomJoin  string
	BottomLeft  string
	BottomRight string
	Middle      string
	MiddleJoin  string
	MiddleLeft  string
	MiddleRight string
	MiddleTop   string
	Top         string
	TopJoin     string
	TopLeft     string
	TopRight    string
	Vertical    string
}

TableBorder defines a series of characters that are used when rendering the border of a table