common

Documentation

Index

• func ButtonView(text string, focused bool) string
• func CancelButtonView(focused bool, defaultButton bool) string
• func HelpView(sections ...string) string
• func IsTTY() bool
• func KeyValueView(stuff ...string) string
• func NewSpinner() spinner.Model
• func NoButtonView(focused bool) string
• func OKButtonView(focused bool, defaultButton bool) string
• func VerticalLine(state State) string
• func YesButtonView(focused bool) string
• type State
• type Styles
  • func DefaultStyles() Styles

Functions

func ButtonView

func ButtonView(text string, focused bool) string

ButtonView renders something that resembles a button.

func CancelButtonView

func CancelButtonView(focused bool, defaultButton bool) string

CancelButtonView returns a button reading "Cancel.".

func HelpView

func HelpView(sections ...string) string

HelpView renders text intended to display at help text, often at the bottom of a view.

func IsTTY

func IsTTY() bool

Returns true if standard out is a terminal.

func KeyValueView

func KeyValueView(stuff ...string) string

KeyValueView renders key-value pairs.

func NewSpinner

func NewSpinner() spinner.Model

NewSpinner returns a spinner model.

func NoButtonView

func NoButtonView(focused bool) string

NoButtonView returns a button reading "No.".

func OKButtonView

func OKButtonView(focused bool, defaultButton bool) string

OKButtonView returns a button reading "OK".

func VerticalLine

func VerticalLine(state State) string

VerticalLine return a vertical line colored according to the given state.

func YesButtonView

func YesButtonView(focused bool) string

YesButtonView return a button reading "Yes".

Types

type State

type State int

State is a general UI state used to help style components.

const (
	StateNormal State = iota
	StateSelected
	StateActive
	StateSpecial
	StateDeleting
)

UI states.

type Styles

type Styles struct {
	Cursor,
	Wrap,
	Paragraph,
	Keyword,
	Code,
	Subtle,
	Error,
	Prompt,
	FocusedPrompt,
	Note,
	NoteDim,
	Delete,
	DeleteDim,
	Label,
	LabelDim,
	ListKey,
	ListDim,
	InactivePagination,
	SelectionMarker,
	SelectedMenuItem,
	Checkmark,
	Logo,
	App lipgloss.Style
}

Styles describes style definitions for various portions of the Charm TUI.

func DefaultStyles

func DefaultStyles() Styles

DefaultStyles returns default styles for the Charm TUI.