clispinner

Documentation

Index

• Constants
• type Option
  • func WithText(text string) Option
  • func WithWriter(w io.Writer) Option
• type Options
• type Spinner
  • func New(options ...Option) *Spinner
  • func (s *Spinner) IsActive() bool
  • func (s *Spinner) SetCharset(charset []string) *Spinner
  • func (s *Spinner) SetColor(color string) *Spinner
  • func (s *Spinner) SetPrefix(text string) *Spinner
  • func (s *Spinner) SetText(text string) *Spinner
  • func (s *Spinner) Start() *Spinner
  • func (s *Spinner) Stop() *Spinner

Constants

const DefaultText = "Initializing..."

DefaultText defines the default spinner text.

Types

type Option

type Option func(*Options)

func WithText

func WithText(text string) Option

WithText configures the spinner text.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter configures an output for a spinner.

type Options

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

type Spinner

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

func New

func New(options ...Option) *Spinner

New creates a new spinner.

func (*Spinner) IsActive

func (s *Spinner) IsActive() bool

func (*Spinner) SetCharset

func (s *Spinner) SetCharset(charset []string) *Spinner

SetCharset sets the prefix for spinner.

func (*Spinner) SetColor

func (s *Spinner) SetColor(color string) *Spinner

SetColor sets the prefix for spinner.

func (*Spinner) SetPrefix

func (s *Spinner) SetPrefix(text string) *Spinner

SetPrefix sets the prefix for spinner.

func (*Spinner) SetText

func (s *Spinner) SetText(text string) *Spinner

SetText sets the text for spinner.

func (*Spinner) Start

func (s *Spinner) Start() *Spinner

Start starts spinning.

func (*Spinner) Stop

func (s *Spinner) Stop() *Spinner

Stop stops spinning.