progressbar

package

v0.0.0-...-cb7a572 Latest Latest Go to latest Published: Aug 25, 2021 License: MIT Imports: 8 Imported by: 1

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

This section is empty.

This section is empty.

This section is empty.

type Model struct {
	Width       int
	Stages      []ProgressFunc
	InitMessage string
	// contains filtered or unexported fields
}

Model is a data container used to store TUI status information.

func (m *Model) Canceled() bool

Canceled determine whether the operation is cancelled

func (m *Model) Error() error

Error returns the error generated during the execution of ProgressFunc

func (m *Model) Index() int

Index returns the index of the ProgressFunc currently executed

func (m Model) Init() tea.Cmd

Init performs some io initialization actions, The current Init returns the first ProgressFunc to trigger the program to run.

func (m *Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update method responds to various events and modifies the data model according to the corresponding events

func (m Model) View() string

View reads the data state of the data model for rendering

type ProgressFunc func() (string, error)

ProgressFunc is a simple function, the progress bar will step a certain distance after each execution