theme

README

Theme

Token palette every glyph component reads from.

Install

glyph add theme

This copies theme.go (and its test file) into your repo at the path your glyph.json aliases declare. After install, the file is yours: edit it, refactor it, rename it. There is no theme library to keep in sync.

Hello, world

package main

import (
	"fmt"

	"github.com/truffle-dev/glyph/components/theme"
)

func main() {
	t := theme.Default     // dark
	// t := theme.Light    // warm paper
	fmt.Println(t.Primary) // lipgloss.Color
}

API surface

Package: theme

Types

• Theme

Dependencies

• github.com/charmbracelet/lipgloss@v1.1.0

Notes

Edit tokens.go to retheme. Default is a dark terminal palette; Light is a warm-paper alternative.

See also

• examples/showcase — single-binary TUI composing the seven main surfaces
• components/theme/story — runnable story binary (go run -tags glyph_story ./components/theme/story/)
• registry manifest — the JSON contract glyph add reads

License

MIT, same as the rest of glyph.

Documentation

Overview

Package theme provides the token palette every glyph component reads from.

Components reference the Default theme; consumers replace tokens by editing this file or constructing their own Theme value.

Index

• Variables
• type Theme

Variables

var Default = Theme{
	Bg:            lipgloss.Color("#0e0e10"),
	Surface:       lipgloss.Color("#16171b"),
	SurfaceStrong: lipgloss.Color("#1f2026"),
	Border:        lipgloss.Color("#2a2c34"),
	BorderStrong:  lipgloss.Color("#3a3c46"),
	Text:          lipgloss.Color("#e6e6ea"),
	TextMuted:     lipgloss.Color("#9a9aa6"),
	TextInverse:   lipgloss.Color("#0e0e10"),

	Primary:       lipgloss.Color("#5e6ad2"),
	PrimaryStrong: lipgloss.Color("#7a86e6"),
	Accent:        lipgloss.Color("#d57e5e"),

	Success: lipgloss.Color("#41b883"),
	Warning: lipgloss.Color("#d8a83c"),
	Error:   lipgloss.Color("#e25555"),
	Info:    lipgloss.Color("#5e9bd2"),

	SyntaxKeyword:     lipgloss.Color("#c586c0"),
	SyntaxString:      lipgloss.Color("#ce9178"),
	SyntaxComment:     lipgloss.Color("#6a7080"),
	SyntaxNumber:      lipgloss.Color("#b5cea8"),
	SyntaxFunction:    lipgloss.Color("#dcdcaa"),
	SyntaxType:        lipgloss.Color("#4ec9b0"),
	SyntaxPunctuation: lipgloss.Color("#9a9aa6"),
}

Default is the dark terminal theme. Edit this file to retheme the entire app.

var Light = Theme{
	Bg:            lipgloss.Color("#fbf6ec"),
	Surface:       lipgloss.Color("#f4ecdb"),
	SurfaceStrong: lipgloss.Color("#e8dcc1"),
	Border:        lipgloss.Color("#d6c8a8"),
	BorderStrong:  lipgloss.Color("#a6987a"),
	Text:          lipgloss.Color("#2a261f"),
	TextMuted:     lipgloss.Color("#7d7460"),
	TextInverse:   lipgloss.Color("#fbf6ec"),

	Primary:       lipgloss.Color("#5e6ad2"),
	PrimaryStrong: lipgloss.Color("#7a86e6"),
	Accent:        lipgloss.Color("#d57e5e"),

	Success: lipgloss.Color("#41b883"),
	Warning: lipgloss.Color("#d8a83c"),
	Error:   lipgloss.Color("#e25555"),
	Info:    lipgloss.Color("#5e9bd2"),

	SyntaxKeyword:     lipgloss.Color("#a040a0"),
	SyntaxString:      lipgloss.Color("#a5562a"),
	SyntaxComment:     lipgloss.Color("#8a7d65"),
	SyntaxNumber:      lipgloss.Color("#4f7a23"),
	SyntaxFunction:    lipgloss.Color("#7a5e0c"),
	SyntaxType:        lipgloss.Color("#0e7a6a"),
	SyntaxPunctuation: lipgloss.Color("#7d7460"),
}

Light is the light-paper theme. Most components target Default; Light is a drop-in replacement when the consumer's terminal background is bright.

Types

type Theme

type Theme struct {
	// Foundational
	Bg            lipgloss.Color
	Surface       lipgloss.Color
	SurfaceStrong lipgloss.Color
	Border        lipgloss.Color
	BorderStrong  lipgloss.Color
	Text          lipgloss.Color
	TextMuted     lipgloss.Color
	TextInverse   lipgloss.Color

	// Accents
	Primary       lipgloss.Color
	PrimaryStrong lipgloss.Color
	Accent        lipgloss.Color

	// Status
	Success lipgloss.Color
	Warning lipgloss.Color
	Error   lipgloss.Color
	Info    lipgloss.Color

	// Syntax (source-code highlighting palette). Components that don't render
	// source code can ignore these. Empty values fall back to Text or muted.
	SyntaxKeyword     lipgloss.Color
	SyntaxString      lipgloss.Color
	SyntaxComment     lipgloss.Color
	SyntaxNumber      lipgloss.Color
	SyntaxFunction    lipgloss.Color
	SyntaxType        lipgloss.Color
	SyntaxPunctuation lipgloss.Color
}

Theme is the token palette shared across glyph components.