Enum ProgressOption

pub enum ProgressOption {
    WithDefaultGradient,
    WithGradient(String, String),
    WithDefaultScaledGradient,
    WithScaledGradient(String, String),
    WithSolidFill(String),
    WithFillCharacters(char, char),
    WithoutPercentage,
    WithWidth(i32),
    WithSpringOptions(f64, f64),
}

Configuration options for customizing progress bar behavior and appearance.

This enum provides a builder pattern for configuring progress bars with various visual and behavioral options. Options can be combined to create highly customized progress bars that match your application’s design and functionality needs.

Examples

Basic Customization

use bubbletea_widgets::progress::{new, with_width, with_solid_fill};

let progress = new(&[
    with_width(60),
    with_solid_fill("#00ff00".to_string()),
]);

Advanced Gradient Configuration

use bubbletea_widgets::progress::{new, with_gradient, with_width, without_percentage};

let gradient_progress = new(&[
    with_width(80),
    with_gradient("#ff4757".to_string(), "#5352ed".to_string()),
    without_percentage(),
]);

Variants

WithDefaultGradient

Uses the default gradient colors (purple to pink). Creates a smooth color transition from #5A56E0 to #EE6FF8.

WithGradient(String, String)

Creates a custom gradient between two specified colors. The first string is the start color, the second is the end color. Colors can be hex codes (“#ff0000”) or named colors.

WithDefaultScaledGradient

Uses the default gradient colors but scales the gradient to fit only the filled portion. This creates a more dynamic visual effect where the gradient adjusts based on progress.

WithScaledGradient(String, String)

Creates a custom scaled gradient that fits only the filled portion of the bar. Combines custom colors with dynamic gradient scaling for maximum visual impact.

WithSolidFill(String)

Sets a solid color fill instead of a gradient. Provides consistent coloring across the entire filled portion.

WithFillCharacters(char, char)

Customizes the characters used for filled and empty portions of the progress bar. First character is for filled sections, second for empty sections.

WithoutPercentage

Hides the percentage text display. Useful when you want a cleaner look or when space is limited.

WithWidth(i32)

Sets the total width of the progress bar in characters. This includes both the bar and percentage text if shown.

WithSpringOptions(f64, f64)

Configures the spring animation parameters for smooth transitions. First value is frequency (speed), second is damping (bounciness).