uxBlock

Documentation

Overview

Package uxBlock provides building blocks for UX and communication with a user.

Index

• func NewBlock(outputLogger logger.Logger, debugFileLogger logger.Logger, isTerminal bool, ...) *uxBlocks
• func XXX(cmdList ...tea.Cmd) func() tea.Msg
• type MergeMessage
• type PromptOption
• type SelectOption
  • func SelectEnableMultiSelect() SelectOption
  • func SelectLabel(label string) SelectOption
  • func SelectTableHeader(header *TableRow) SelectOption
• type Spinner
  • func NewSpinner(line styles.Line) *Spinner
  • func (s *Spinner) Finish(text styles.Line) *Spinner
  • func (s *Spinner) SetMessage(text styles.Line) *Spinner
• type SpinnerOption
• type TableBody
  • func NewTableBody() *TableBody
  • func (b *TableBody) AddRow(row *TableRow)
  • func (b *TableBody) AddStringsRow(cells ...string) *TableBody
  • func (b *TableBody) AddStringsRows(rows ...[]string) *TableBody
• type TableCell
  • func NewTableCell(text string) *TableCell
• type TableOption
  • func WithTableHeader(header *TableRow) TableOption
• type TableRow
  • func NewTableRow() *TableRow
  • func (r *TableRow) AddCell(cell *TableCell) *TableRow
  • func (r *TableRow) AddStringCell(text string) *TableRow
  • func (r *TableRow) AddStringCells(cells ...string) *TableRow
• type UxBlocks

Functions

func NewBlock

func NewBlock(
	outputLogger logger.Logger,
	debugFileLogger logger.Logger,
	isTerminal bool,
	terminalWidth int,
	ctxCancel context.CancelFunc,
) *uxBlocks

func XXX

func XXX(cmdList ...tea.Cmd) func() tea.Msg

Types

type MergeMessage

type MergeMessage []tea.Cmd

type PromptOption

type PromptOption = func(cfg *promptConfig)

type SelectOption

type SelectOption = func(cfg *selectConfig)

func SelectEnableMultiSelect

func SelectEnableMultiSelect() SelectOption

func SelectLabel

func SelectLabel(label string) SelectOption

func SelectTableHeader

func SelectTableHeader(header *TableRow) SelectOption

type Spinner

type Spinner struct {
	// contains filtered or unexported fields
}

func NewSpinner

func NewSpinner(line styles.Line) *Spinner

func (*Spinner) Finish

func (s *Spinner) Finish(text styles.Line) *Spinner

func (*Spinner) SetMessage

func (s *Spinner) SetMessage(text styles.Line) *Spinner

type SpinnerOption

type SpinnerOption = func(cfg *spinnerConfig)

type TableBody

type TableBody struct {
	// contains filtered or unexported fields
}

func NewTableBody

func NewTableBody() *TableBody

func (*TableBody) AddRow

func (b *TableBody) AddRow(row *TableRow)

func (*TableBody) AddStringsRow

func (b *TableBody) AddStringsRow(cells ...string) *TableBody

func (*TableBody) AddStringsRows

func (b *TableBody) AddStringsRows(rows ...[]string) *TableBody

type TableCell

type TableCell struct {
	Text string
}

func NewTableCell

func NewTableCell(text string) *TableCell

type TableOption

type TableOption = func(cfg *tableConfig)

func WithTableHeader

func WithTableHeader(header *TableRow) TableOption

type TableRow

type TableRow struct {
	// contains filtered or unexported fields
}

func NewTableRow

func NewTableRow() *TableRow

func (*TableRow) AddCell

func (r *TableRow) AddCell(cell *TableCell) *TableRow

func (*TableRow) AddStringCell

func (r *TableRow) AddStringCell(text string) *TableRow

func (*TableRow) AddStringCells

func (r *TableRow) AddStringCells(cells ...string) *TableRow

type UxBlocks

type UxBlocks interface {
	LogDebug(message string)
	PrintInfo(line styles.Line)
	PrintWarning(line styles.Line)
	PrintError(line styles.Line)
	Table(body *TableBody, auxOptions ...TableOption)
	Select(ctx context.Context, tableBody *TableBody, auxOptions ...SelectOption) ([]int, error)
	Prompt(
		ctx context.Context,
		message string,
		choices []string,
		auxOptions ...PromptOption,
	) (int, error)
	RunSpinners(ctx context.Context, spinners []*Spinner, auxOptions ...SpinnerOption) func()
}