spinner

Documentation

Index

• Variables
• type Frames
• type Option
  • func WithFrameRate(value time.Duration) Option
  • func WithFrames(value Frames) Option
  • func WithHideCursor(value bool) Option
  • func WithLabel(value string) Option
  • func WithMaxWidth(value int) Option
  • func WithOutput(value io.Writer) Option
  • func WithStyle(value *gchalk.Builder) Option
• type Widget
  • func New(options ...Option) *Widget
  • func (s *Widget) SetLabel(label string) *Widget
  • func (s *Widget) Start() *Widget
  • func (s *Widget) Stop() *Widget

Variables

var (
	FramesBall          = Frames{"∙∙∙", "●∙∙", "∙●∙", "∙∙●", "∙∙∙"}
	FramesBarHorizontal = Frames{"▏", "▎", "▍", "▌", "▋", "▊", "▉", "▊", "▋", "▌", "▍", "▎"}
	FramesBarsVertical  = Frames{"▁", "▃", "▄", "▅", "▆", "▇", "█", "▇", "▆", "▅", "▄", "▃", "▁"}
)

Types

type Frames

type Frames []string

Frames ...

type Option

type Option func(*Widget)

Option will apply the provided configuration to a spinner instance.

func WithFrameRate

func WithFrameRate(value time.Duration) Option

WithFrameRate adds color style

func WithFrames

func WithFrames(value Frames) Option

WithFrames adds color style

func WithHideCursor

func WithHideCursor(value bool) Option

WithHideCursor adds color style

func WithLabel

func WithLabel(value string) Option

WithLabel adds color style

func WithMaxWidth

func WithMaxWidth(value int) Option

WithMaxWidth adds color style

func WithOutput

func WithOutput(value io.Writer) Option

WithOutput adds color style

func WithStyle

func WithStyle(value *gchalk.Builder) Option

WithStyle adds color style

type Widget

type Widget struct {
	sync.Mutex
	Label     string
	Frames    Frames
	FrameRate time.Duration

	Output io.Writer

	Style      *gchalk.Builder
	MaxWidth   int
	HideCursor bool
	// contains filtered or unexported fields
}

Widget is the spinner struct

func New

func New(options ...Option) *Widget

New creates a new Spinner instance

func (*Widget) SetLabel

func (s *Widget) SetLabel(label string) *Widget

SetLabel updates the label value

func (*Widget) Start

func (s *Widget) Start() *Widget

Start starts the spinner

func (*Widget) Stop

func (s *Widget) Stop() *Widget

Stop will stop the spinner