ui

Documentation

Index

• Constants
• Variables
• func ApplyConfig(cfg Config, system *system.System)
• type Config
  • func DefaultConfig() Config
  • func (c *Config) GetSelectedTheme(system *system.System) style.ThemeValues
• type MessagePrinter
• type NamedTheme
• type OkButton
• type TUI
  • func NewTUI(options ...TUIOption) TUI
• type TUIOption
  • func WithScreen(screen tcell.Screen) TUIOption
  • func WithStdio(stdio termutil.Stdio) TUIOption

Constants

const (
	OkButtonExecute = OkButton("Execute")
	OkButtonPrint   = OkButton("Print")
)

Variables

var (
	ErrInvalidTheme = errors.New("invalid theme")
)

Functions

func ApplyConfig

func ApplyConfig(cfg Config, system *system.System)

Types

type Config

type Config struct {
	Theme      string `` /* 130-byte string literal not displayed */
	HideKeyMap bool   `yaml:"hideKeyMap,omitempty" head_comment:"If set to true, the key map won't be displayed. Default value: false"`
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) GetSelectedTheme

func (c *Config) GetSelectedTheme(system *system.System) style.ThemeValues

type MessagePrinter

type MessagePrinter interface {
	Print(uimsg.Printable)
}

type NamedTheme

type NamedTheme struct {
	Name   string            `yaml:"name"`
	Values style.ThemeValues `yaml:"values" head_comment:"A color can be created from a color name (W3C name) or by a hex value in the format #ffffff."`
}

type OkButton

type OkButton string

type TUI

type TUI interface {
	ApplyConfig(cfg Config, system *system.System)
	Print(m uimsg.Printable)
	PrintAndExit(uimsg.Printable, int)
	PrintMessage(message string)
	PrintError(message string)
	Confirmation(confirm uimsg.Confirm, options ...confirm.Option) bool
	OpenEditor(path string, preferredEditor string)
	ShowLookup(snippets []model.Snippet, fuzzySearch bool) int
	ShowParameterForm(parameters []model.Parameter, values []model.ParameterValue, okButton OkButton) ([]string, bool)
	ShowPicker(title string, items []picker.Item, selectedItem *picker.Item, options ...tea.ProgramOption) (int, bool)
	ShowSync() sync.Screen
	ShowAssistantPrompt([]string) (bool, string)
	ShowAssistantWizard(config wizard.Config) (bool, wizard.Result)
	ShowSpinner(string, string, chan bool)
}

func NewTUI

func NewTUI(options ...TUIOption) TUI

type TUIOption

type TUIOption interface {
	// contains filtered or unexported methods
}

TUIOption configures a TUI.

func WithScreen

func WithScreen(screen tcell.Screen) TUIOption

WithScreen sets the screen for tview.

func WithStdio

func WithStdio(stdio termutil.Stdio) TUIOption

WithStdio sets the stdio for the terminal.