progressformatter

Documentation

Overview

Package progressformatter is an implementation based on github.com/wagoodman/go-progress/simple

Index

• Variables
• type Formatter
  • func NewFormatter(width int) *Formatter
  • func NewFormatterWithTheme(width int, theme Theme) *Formatter
  • func (f *Formatter) Format(p progress.Progress) string
• type Theme

Variables

var DefaultTheme = Theme{
	Filled:         color.HEX("#fcba03").Sprintf(">"),
	Empty:          color.HEX("#777777").Sprintf(">"),
	StartDelimiter: color.HEX("#777777").Sprintf("["),
	EndDelimiter:   color.HEX("#777777").Sprintf("]"),
}

DefaultTheme is the default theme for progress formatter.

Types

type Formatter

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

Formatter is the formatter of progress bar.

func NewFormatter

func NewFormatter(width int) *Formatter

NewFormatter will initialize a formatter with the default theme.

func NewFormatterWithTheme

func NewFormatterWithTheme(width int, theme Theme) *Formatter

NewFormatterWithTheme will initialize a formatter with a specific theme.

func (*Formatter) Format

func (f *Formatter) Format(p progress.Progress) string

Format will format the bar with progress.

type Theme

type Theme struct {
	Filled         string
	Empty          string
	StartDelimiter string
	EndDelimiter   string
}

Theme is the theme of the progress bar.