wow

package module

v0.1.0 Latest Latest Go to latest Published: Jan 17, 2019 License: MIT Imports: 9 Imported by: 66

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gernest/wow

Links

Open Source Insights

README ¶

wow

Beautiful spinners for Go commandline apps

wow

Install

go get -u github.com/gernest/wow

Usage

package main

import (
	"os"
	"time"

	"github.com/gernest/wow"
	"github.com/gernest/wow/spin"
)

func main() {
	w := wow.New(os.Stdout, spin.Get(spin.Dots), "Such Spins")
	w.Start()
	time.Sleep(2 * time.Second)
	w.Text("Very emojis").Spinner(spin.Get(spin.Hearts))
	time.Sleep(2 * time.Second)
	w.PersistWith(spin.Spinner{Frames: []string{"👍"}}, " Wow!")
}

Available spinners

Name	What it looks like
`Star2`
`GrowHorizontal`
`Squish`
`Toggle12`
`Smiley`
`Hearts`
`Dots3`
`Dots11`
`Balloon`
`Clock`
`Dots4`
`SquareCorners`
`CircleHalves`
`Star`
`Arc`
`Toggle13`
`BoxBounce`
`Line2`
`Pipe`
`Triangle`
`Shark`
`Line`
`Arrow`
`Earth`
`Dots5`
`Toggle11`
`CircleQuarters`
`Toggle9`
`Dots9`
`Bounce`
`Toggle2`
`Toggle7`
`Arrow3`
`Moon`
`Dots6`
`Christmas`
`Dots10`
`Hamburger`
`BoxBounce2`
`BouncingBar`
`Flip`
`Dots8`
`Dots12`
`Noise`
`Toggle3`
`Toggle6`
`Runner`
`Dqpb`
`Dots`
`Toggle4`
`Monkey`
`Dots7`
`SimpleDots`
`GrowVertical`
`Circle`
`Toggle`
`Toggle5`
`Arrow2`
`Dots2`
`Toggle8`
`Toggle10`
`BouncingBall`
`SimpleDotsScrolling`
`Pong`
`Weather`
`Balloon2`

Documentation ¶

Index ¶

func ForceOutput(w *Wow)
type LogSymbol
- func (s LogSymbol) String() string
type Wow
- func New(o io.Writer, s spin.Spinner, text string, options ...func(*Wow)) *Wow

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ForceOutput ¶

func ForceOutput(w *Wow)

ForceOutput forces all output even if not not outputting directly to a terminal

Types ¶

type LogSymbol ¶

type LogSymbol uint

LogSymbol is a log severity level

const (
	INFO LogSymbol = iota
	SUCCESS
	WARNING
	ERROR
)

common log symbos

func (LogSymbol) String ¶

func (s LogSymbol) String() string

type Wow ¶

type Wow struct {
	IsTerminal bool
	// contains filtered or unexported fields
}

Wow writes beautiful spinners on the terminal.

func New ¶

func New(o io.Writer, s spin.Spinner, text string, options ...func(*Wow)) *Wow

New creates a new wow instance ready to start spinning.

func (*Wow) Persist ¶

func (w *Wow) Persist()

Persist writes the last character of the currect spinner frames together with the text on stdout.

A new line is added at the end to ensure the text stay that way.

func (*Wow) PersistWith ¶

func (w *Wow) PersistWith(s spin.Spinner, text string)

PersistWith writes the last frame of s together with text with a new line added to make it stick.

func (*Wow) Spinner ¶

func (w *Wow) Spinner(s spin.Spinner) *Wow

Spinner sets s to the current spinner

func (*Wow) Start ¶

func (w *Wow) Start()

Start starts the spinner. The frames are written based on the spinner interval.

func (*Wow) Stop ¶

func (w *Wow) Stop()

Stop stops the spinner

func (*Wow) Text ¶

func (w *Wow) Text(txt string) *Wow

Text adds text to the current spinner

Source Files ¶

View all Source files

wow.go

Directories ¶

Path	Synopsis
example
all DO NOT EDIT : this file was automatically generated.	DO NOT EDIT : this file was automatically generated.
doge
scripts
spin DO NOT EDIT : this file was automatically generated.	DO NOT EDIT : this file was automatically generated.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL