Skip to main content

MaterialProgress

Struct MaterialProgress 

Source
pub struct MaterialProgress { /* private fields */ }
Expand description

Material Design progress indicator component

Progress indicators inform users about the status of ongoing processes, such as loading an app, submitting a form, or saving updates. They communicate an app’s state and indicate available actions.

§Usage Examples

// Linear progress with value
ui.add(MaterialProgress::linear()
    .value(0.65)
    .size(Vec2::new(300.0, 6.0)));

// Circular progress with value
ui.add(MaterialProgress::circular()
    .value(0.8)
    .size(Vec2::splat(64.0)));

// Indeterminate linear progress (loading)
ui.add(MaterialProgress::linear()
    .indeterminate(true));

// Buffered linear progress (like video loading)
ui.add(MaterialProgress::linear()
    .value(0.3)
    .buffer(0.6));

// Customized colors and style
ui.add(MaterialProgress::linear()
    .value(0.5)
    .active_color(Color32::RED)
    .track_color(Color32::LIGHT_GRAY)
    .track_gap(4.0)
    .stop_indicator_radius(2.0));

§Material Design Spec

  • Linear: 4dp height (default), variable width
  • Circular: 48dp diameter (default), 4dp stroke width
  • Colors: Primary color for progress, secondaryContainer for track
  • Animation: Smooth transitions, indeterminate animations
  • Corner radius: pill-shaped for linear progress
  • Track gap: 4dp between indicator and track (M3 2024)
  • Stop indicator: 2dp radius dot at track end (linear determinate)

Implementations§

Source§

impl MaterialProgress

Source

pub fn new(variant: ProgressVariant) -> Self

Create a new progress indicator with the specified variant

Source

pub fn linear() -> Self

Create a linear progress bar

Source

pub fn circular() -> Self

Create a circular progress indicator

Source

pub fn value(self, value: f32) -> Self

Set the current progress value (clamped between 0.0 and max)

Source

pub fn max(self, max: f32) -> Self

Set the maximum value for progress calculation (default: 1.0)

Source

pub fn buffer(self, buffer: f32) -> Self

Set the buffer value for buffered progress (e.g., video buffering)

Source

pub fn indeterminate(self, indeterminate: bool) -> Self

Enable or disable indeterminate progress animation

Source

pub fn four_color_enabled(self, enabled: bool) -> Self

Enable or disable four-color animation for indeterminate progress

Source

pub fn size(self, size: Vec2) -> Self

Set the size of the progress indicator

Source

pub fn width(self, width: f32) -> Self

Set the width of the progress indicator

Source

pub fn height(self, height: f32) -> Self

Set the height of the progress indicator

Source

pub fn active_color(self, color: Color32) -> Self

Set the indicator/active color (default: theme primary)

Source

pub fn track_color(self, color: Color32) -> Self

Set the track background color (default: theme secondaryContainer)

Source

pub fn buffer_color(self, color: Color32) -> Self

Set the buffer indicator color (default: theme primaryContainer)

Source

pub fn border_radius(self, radius: f32) -> Self

Set the corner radius for linear progress (default: height / 2.0 for pill shape)

Source

pub fn stroke_width(self, width: f32) -> Self

Set the stroke width for circular progress (default: 4.0)

Source

pub fn track_gap(self, gap: f32) -> Self

Set the gap between indicator and track (default: 4.0, set 0 to hide)

Source

pub fn stop_indicator_radius(self, radius: f32) -> Self

Set the stop indicator dot radius for linear determinate (default: 2.0, set 0 to hide)

Source

pub fn stop_indicator_color(self, color: Color32) -> Self

Set the stop indicator dot color (default: theme primary)

Source

pub fn four_color(self, enabled: bool) -> Self

👎Deprecated: Use four_color_enabled() instead

Enable or disable four-color animation (deprecated, use four_color_enabled)

Trait Implementations§

Source§

impl Widget for MaterialProgress

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more