screen

Documentation

Overview

Package screen provides building blocks to represent progress bars.

Index

• Variables
• func NewProgressLine(table *TableGenerator, initialLabel string) (*ProgressLine, Segment)
• type AutoRefreshScreen
  • func NewAutoRefreshScreen(options RenderingOptions, bars ...Segment) *AutoRefreshScreen
  • func (s *AutoRefreshScreen) Stop()
• type LineSpinnerSegment
  • func NewSpinnerSegment() *LineSpinnerSegment
  • func (l *LineSpinnerSegment) Content(options RenderingOptions) string
• type PagePrint
• type ProgressBarSegment
  • func (p *ProgressBarSegment) Content(options RenderingOptions) string
• type ProgressLine
• type RenderingOptions
• type Segment
  • func NewConstantSegment(content string) Segment
  • func NewGreenTickSegment() Segment
  • func NewProgressBarSegment() (Segment, func(uint, uint))
  • func NewSwitchSegment(delegates ...Segment) (Segment, func(int))
  • func NewUpdatableSegment(content string) (Segment, func(string))
• type SimpleScreen
  • func NewSimpleScreen(options RenderingOptions, bars ...Segment) *SimpleScreen
  • func (s *SimpleScreen) Clear()
  • func (s *SimpleScreen) ContentHeight() int
  • func (s *SimpleScreen) ForceClear()
  • func (s *SimpleScreen) Print(page PagePrint)
  • func (s *SimpleScreen) Refresh()
  • func (s *SimpleScreen) TermSize() (int, int)
• type StringSegment
  • func (l *StringSegment) Content(options RenderingOptions) string
• type SwitchSegment
  • func (s *SwitchSegment) Content(options RenderingOptions) string
• type TableGenerator
  • func NewTable(separator string, widths ...int) *TableGenerator
  • func (t *TableGenerator) NewRow(delegates ...Segment) Segment

Variables

var SpinnerDefaultStyle = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"}

Functions

func NewProgressLine

func NewProgressLine(table *TableGenerator, initialLabel string) (*ProgressLine, Segment)

Types

type AutoRefreshScreen

type AutoRefreshScreen struct {
	SimpleScreen
	// contains filtered or unexported fields
}

func NewAutoRefreshScreen

func NewAutoRefreshScreen(options RenderingOptions, bars ...Segment) *AutoRefreshScreen

func (*AutoRefreshScreen) Stop

func (s *AutoRefreshScreen) Stop()

type LineSpinnerSegment

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

func NewSpinnerSegment

func NewSpinnerSegment() *LineSpinnerSegment

func (*LineSpinnerSegment) Content

func (l *LineSpinnerSegment) Content(options RenderingOptions) string

type PagePrint

type PagePrint struct {
	Content []Segment
	Footer  []Segment
}

type ProgressBarSegment

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

func (*ProgressBarSegment) Content

func (p *ProgressBarSegment) Content(options RenderingOptions) string

type ProgressLine

type ProgressLine struct {
	SwapSpinner    func(int)
	SetLabel       func(string)
	SetBar         func(uint, uint)
	SetExplanation func(string)
}

type RenderingOptions

type RenderingOptions struct {
	Width int
	Full  bool // Full set to true will clear the whole terminal
}

type Segment

type Segment interface {
	Content(options RenderingOptions) string
}

func NewConstantSegment

func NewConstantSegment(content string) Segment

NewConstantSegment creates a constant segment

func NewGreenTickSegment

func NewGreenTickSegment() Segment

func NewProgressBarSegment

func NewProgressBarSegment() (Segment, func(uint, uint))

func NewSwitchSegment

func NewSwitchSegment(delegates ...Segment) (Segment, func(int))

NewSwitchSegment creates a segment that can switch from one implementation to the other ; returns func to swap that will panic if index out of bound.

func NewUpdatableSegment

func NewUpdatableSegment(content string) (Segment, func(string))

NewUpdatableSegment returns the segment and the function to update it

type SimpleScreen

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

func NewSimpleScreen

func NewSimpleScreen(options RenderingOptions, bars ...Segment) *SimpleScreen

func (*SimpleScreen) Clear

func (s *SimpleScreen) Clear()

Clear goes back to the beginning

func (*SimpleScreen) ContentHeight

func (s *SimpleScreen) ContentHeight() int

ContentHeight returns number of lines used in content (excluding footer)

func (*SimpleScreen) ForceClear

func (s *SimpleScreen) ForceClear()

ForceClear goes back to the beginning after writing white spaces everywhere

func (*SimpleScreen) Print

func (s *SimpleScreen) Print(page PagePrint)

Print writes given segments in the output ; it doesn't keep the segments and doesn't refresh the page.

func (*SimpleScreen) Refresh

func (s *SimpleScreen) Refresh()

func (*SimpleScreen) TermSize

func (s *SimpleScreen) TermSize() (int, int)

TermSize returns the size of the terminal, in chars

type StringSegment

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

func (*StringSegment) Content

func (l *StringSegment) Content(options RenderingOptions) string

type SwitchSegment

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

func (*SwitchSegment) Content

func (s *SwitchSegment) Content(options RenderingOptions) string

type TableGenerator

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

func NewTable

func NewTable(separator string, widths ...int) *TableGenerator

func (*TableGenerator) NewRow

func (t *TableGenerator) NewRow(delegates ...Segment) Segment