spinner

Documentation

Index

• type Option
  • func WithDisableOutputResult() Option
  • func WithPrompt(prompt string) Option
  • func WithQuitKey(key key.Binding) Option
  • func WithShape(shape components.Shape) Option
  • func WithShapeStyle(style *style.Style) Option
• type Spinner
  • func New(ops ...Option) *Spinner
  • func (s *Spinner) Apply(ops ...Option) *Spinner
  • func (s *Spinner) Display(runner func(spinner *Spinner)) error
  • func (s *Spinner) Finish(prompt ...string)
  • func (s *Spinner) Refresh(prompt string)
  • func (s *Spinner) Refreshf(format string, a ...any)

Types

type Option

type Option func(s *Spinner)

func WithDisableOutputResult

func WithDisableOutputResult() Option

WithDisableOutputResult disable output result.

func WithPrompt

func WithPrompt(prompt string) Option

WithPrompt replace default prompt

func WithQuitKey

func WithQuitKey(key key.Binding) Option

WithQuitKey replace `Quit` key, user interrupt, kill program.

func WithShape

func WithShape(shape components.Shape) Option

WithShape default is Line

func WithShapeStyle

func WithShapeStyle(style *style.Style) Option

WithShapeStyle default theme.DefaultTheme#SpinnerShapeStyle

type Spinner

type Spinner struct {
	*components.PrintHelper
	// contains filtered or unexported fields
}

func New

func New(ops ...Option) *Spinner

New Spinner

func (*Spinner) Apply

func (s *Spinner) Apply(ops ...Option) *Spinner

Apply options on Select

func (*Spinner) Display

func (s *Spinner) Display(runner func(spinner *Spinner)) error

Display Spinner

func (*Spinner) Finish

func (s *Spinner) Finish(prompt ...string)

Finish Spinner

func (*Spinner) Refresh

func (s *Spinner) Refresh(prompt string)

Refresh Spinner prompt

func (*Spinner) Refreshf

func (s *Spinner) Refreshf(format string, a ...any)

Refreshf Spinner prompt