ui

Documentation

Index

• Variables
• func Domains(domains []string) string
• func Exit() tea.Msg
• func List[T any](items []ListItem[T]) list.Model
• func NewDriverTUI(ctx context.Context) (*Driver, Program)
• func WaitingSpinner() spinner.Model
• type Driver
  • func NewDriverTTY(ctx context.Context) *Driver
  • func NewDriverTest(ctx context.Context) *Driver
  • func (d *Driver) Activate(ctx context.Context, model tea.Model)
  • func (d *Driver) ErrorView() string
  • func (d *Driver) Golden() string
  • func (d *Driver) Init() tea.Cmd
  • func (d *Driver) Pause() chan<- struct{}
  • func (d *Driver) Stop()
  • func (d *Driver) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (d *Driver) View() string
• type Error
  • func (e Error) Error() string
  • func (e Error) Unwrap() error
• type ListItem
  • func (li ListItem[T]) FilterValue() string
• type MessageFunc
  • func (MessageFunc) Init() tea.Cmd
  • func (m MessageFunc) Update(tea.Msg) (tea.Model, tea.Cmd)
  • func (m MessageFunc) View() string
• type MessageLines
  • func (MessageLines) Init() tea.Cmd
  • func (m MessageLines) Update(tea.Msg) (tea.Model, tea.Cmd)
  • func (m MessageLines) View() string
• type Program
• type Section
  • func (s Section) Section() string

Variables

var (
	Header    = header.SetString("\n#").Render
	Skip      = header.Faint(true).SetString("\n# Skipped:").Render
	Hint      = hint.Render
	Underline = lipgloss.NewStyle().Underline(true).Render
	Warning   = header.SetString(bgBanana(fgMidnight("!")) + fgBanana(" Warning:")).Render

	StepAlert      = lipgloss.NewStyle().SetString("    " + Announce("!")).Render
	StepDone       = lipgloss.NewStyle().SetString("    -").Render
	StepHint       = hint.SetString("    |").Render
	StepNext       = hint.SetString("    -").Render
	StepInProgress = lipgloss.NewStyle().SetString("    *").Render
	StepPrompt     = lipgloss.NewStyle().SetString("    " + Prompt.Render("?")).Render
	StepWarning    = header.SetString("    " + bgBanana(fgMidnight("!")) + fgBanana(" Warning:")).Render

	Accentuate         = lipgloss.NewStyle().Italic(true).Render
	Action             = lipgloss.NewStyle().Bold(true).Foreground(colorBrandPrimary).Render
	Announce           = lipgloss.NewStyle().Background(colorBrandSecondary).Render
	Danger             = lipgloss.NewStyle().Bold(true).Foreground(colorDanger).Render
	Emphasize          = lipgloss.NewStyle().Bold(true).Render
	EmphasizeUnderline = lipgloss.NewStyle().Bold(true).Underline(true).Render
	Titlize            = lipgloss.NewStyle().Bold(true).Render
	URL                = lipgloss.NewStyle().Faint(true).Underline(true).Render
	Whisper            = lipgloss.NewStyle().Faint(true).Render

	Prompt = lipgloss.NewStyle().Foreground(colorBrandPrimary)

	Waiting = spinner.MiniDot
)

Functions

func Domains

func Domains(domains []string) string

func Exit

func Exit() tea.Msg

func List

func List[T any](items []ListItem[T]) list.Model

func NewDriverTUI

func NewDriverTUI(ctx context.Context) (*Driver, Program)

func WaitingSpinner

func WaitingSpinner() spinner.Model

Types

type Driver

type Driver struct {
	Program // TUI mode

	TTY termenv.File
	// contains filtered or unexported fields
}

func NewDriverTTY

func NewDriverTTY(ctx context.Context) *Driver

func NewDriverTest

func NewDriverTest(ctx context.Context) *Driver

func (*Driver) Activate

func (d *Driver) Activate(ctx context.Context, model tea.Model)

func (*Driver) ErrorView

func (d *Driver) ErrorView() string

func (*Driver) Golden

func (d *Driver) Golden() string

func (*Driver) Init

func (d *Driver) Init() tea.Cmd

func (*Driver) Pause

func (d *Driver) Pause() chan<- struct{}

func (*Driver) Stop

func (d *Driver) Stop()

func (*Driver) Update

func (d *Driver) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Driver) View

func (d *Driver) View() string

type Error

type Error struct {
	tea.Model

	Err error // reported error
}

func (Error) Error

func (e Error) Error() string

func (Error) Unwrap

func (e Error) Unwrap() error

type ListItem

type ListItem[T any] struct {
	Key    string
	String string
	Value  T
}

func (ListItem[T]) FilterValue

func (li ListItem[T]) FilterValue() string

type MessageFunc

type MessageFunc func(*strings.Builder)

func (MessageFunc) Init

func (MessageFunc) Init() tea.Cmd

func (MessageFunc) Update

func (m MessageFunc) Update(tea.Msg) (tea.Model, tea.Cmd)

func (MessageFunc) View

func (m MessageFunc) View() string

type MessageLines

type MessageLines []string

func (MessageLines) Init

func (MessageLines) Init() tea.Cmd

func (MessageLines) Update

func (m MessageLines) Update(tea.Msg) (tea.Model, tea.Cmd)

func (MessageLines) View

func (m MessageLines) View() string

type Program

type Program interface {
	Quit()
	Run() (tea.Model, error)
	Send(tea.Msg)
	Wait()
}

type Section

type Section struct {
	Name string

	tea.Model
}

func (Section) Section

func (s Section) Section() string