spinner

Documentation

Index

• func Start(d time.Duration, opts ...Option) func()
• type Option
  • func WithColor(color string) Option
  • func WithCustomSet(set []string) Option
  • func WithFinalMSG(msg string) Option
  • func WithHiddenCursor(hide bool) Option
  • func WithPredefinedSet(n int) Option
  • func WithSuffix(suffix string) Option
  • func WithWriter(w io.Writer) Option

Functions

func Start

func Start(d time.Duration, opts ...Option) func()

Start run spinner with the supplied options.

Types

type Option

type Option func(*options)

Option is a function that takes a spinner and applies a given configuration.

func WithColor

func WithColor(color string) Option

WithColor adds the given color to the spinner.

func WithCustomSet

func WithCustomSet(set []string) Option

WithCustomSet adds the given custom charsets the spinner.

func WithFinalMSG

func WithFinalMSG(msg string) Option

WithFinalMSG adds the given string ot the spinner as the final message to be written.

func WithHiddenCursor

func WithHiddenCursor(hide bool) Option

WithHiddenCursor hides the cursor if hideCursor = true given.

func WithPredefinedSet

func WithPredefinedSet(n int) Option

WithPredefinedSet adds the given predefined charsets the spinner. https://github.com/briandowns/spinner#available-character-sets

func WithSuffix

func WithSuffix(suffix string) Option

WithSuffix adds the given string to the spinner as the suffix.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter adds the given writer to the spinner. This function should be favored over directly assigning to the struct value.