ui

package

v0.0.36 Latest Latest Go to latest Published: May 20, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/anchordotdev/cli

Links

Open Source Insights

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
type ListItem
- func (li ListItem[T]) FilterValue() string
type MessageFunc
type MessageLines
type Program
type Section
- func (s Section) Section() string

Constants ¶

This section is empty.

Variables ¶

View Source

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

	StepAlert      = lipgloss.NewStyle().SetString("    " + Announce("!")).Render
	StepDone       = lipgloss.NewStyle().SetString("    -").Render
	StepHint       = hint.Copy().SetString("    |").Render
	StepInProgress = lipgloss.NewStyle().SetString("    *").Render
	StepPrompt     = lipgloss.NewStyle().SetString("    " + Prompt.Render("?")).Render
	StepWarning    = header.Copy().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
	Error              = 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 ¶ added in v0.0.11

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 ¶ added in v0.0.10

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 ¶ added in v0.0.14

func NewDriverTest(ctx context.Context) *Driver

func (*Driver) Activate ¶

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

func (*Driver) ErrorView ¶ added in v0.0.32

func (d *Driver) ErrorView() string

func (*Driver) Golden ¶ added in v0.0.33

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 ListItem ¶

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

func (ListItem[T]) FilterValue ¶

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

type MessageFunc ¶ added in v0.0.35

type MessageFunc func(*strings.Builder)

func (MessageFunc) Init ¶ added in v0.0.35

func (MessageFunc) Init() tea.Cmd

func (MessageFunc) Update ¶ added in v0.0.35

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

func (MessageFunc) View ¶ added in v0.0.35

func (m MessageFunc) View() string

type MessageLines ¶ added in v0.0.35

type MessageLines []string

func (MessageLines) Init ¶ added in v0.0.35

func (MessageLines) Init() tea.Cmd

func (MessageLines) Update ¶ added in v0.0.35

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

func (MessageLines) View ¶ added in v0.0.35

func (m MessageLines) View() string

type Program ¶

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

type Section ¶ added in v0.0.35

type Section struct {
	Name string

	tea.Model
}

func (Section) Section ¶ added in v0.0.35

func (s Section) Section() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
uitest

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL