progress

package

v1.22.3 Latest Latest Go to latest Published: Feb 26, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Package progress provides a themed progress bar component.

This section is empty.

This section is empty.

This section is empty.

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

Model wraps the Bubbles progress component with theming.

func New(theme styles.Theme, width int) *Model

New creates a new progress bar.

func (m *Model) Init() tea.Cmd

Init implements tea.Model.

func (m *Model) SetPercent(percent float64) tea.Cmd

SetPercent returns a command to animate to the given percentage (0-1).

func (m *Model) SetWidth(width int)

SetWidth sets the progress bar width.

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

Update implements tea.Model.

func (m *Model) View() string

View renders the progress bar at its current percentage.

func (m *Model) ViewAs(percent float64) string

ViewAs renders the progress bar at a specific percentage without animation. Percent should be 0-100.