spinner

Documentation

Overview

Package spinner provides methods for creating spinner animation for long-running tasks

Index

• Variables
• func Done(ok bool)
• func Show(message string, args ...interface{})
• func Skip()
• func Update(message string, args ...interface{})

Examples

• Done
• Show
• Update

Variables

var DisableAnimation = false

DisableAnimation is global animation off switch flag

var ErrColorTag = "{r}"

ErrColorTag is cross color tag (see fmtc package)

var OkColorTag = "{g}"

OkColorTag is check color tag (see fmtc package)

var SkipColorTag = "{s}"

SkipColorTag is skipped action color tag (see fmtc package)

var SpinnerColorTag = "{y}"

SpinnerColorTag is spinner animation color tag (see fmtc package)

var TimeColorTag = "{s-}"

TimeColorTag is time color tag (see fmtc package)

Functions

func Done

func Done(ok bool)

Done finishes spinner animation and shows task status

Example

Show("My long running task with good result")
time.Sleep(time.Second)
Done(true)

Show("My long running task with bad result")
time.Sleep(time.Second)
Done(false)

func Show

func Show(message string, args ...interface{})

Show shows spinner with given task description

Example

file := "file.txt"
Show("Removing file %s", file)
time.Sleep(time.Second)
Done(true)

func Skip

func Skip()

Skip finishes spinner animation and mark it as skipped

func Update

func Update(message string, args ...interface{})

Update updates task description

Example

Show("My long running task")
time.Sleep(time.Second)
Show("My long running task still working")
time.Sleep(time.Second)
Done(true)