Struct ProgressBar

pub struct ProgressBar;

A simple ProgressBar that can be used to show progress of something.

the input lens need to be a f32 with range of 0.0..1.0

Example

Vertical ProgressBar bound to the input lens

ProgressBar::vertical(cx, AppData::progress);

Horizontal ProgressBar bound to the input lens

ProgressBar::horizontal(cx, AppData::progress);

A Horizontal ProgressBar with a label beside it to show the progress

HStack::new(cx, |cx| {
    ProgressBar::horizontal(cx, AppData::progress);
    Label::new(cx, AppData::progress.map(|v| format!("{:.0}%", v * 100.0)));
});

A Horizontal ProgressBar with dynamic bar background color using a lens

we can dynamically change the background color of the bar using bar_color method on Handle

ProgressBar::horizontal(cx, AppData::progress).bar_color(AppData::color);

Implementations

impl ProgressBar

pub fn new<L>( cx: &mut Context, lens: L, orientation: Orientation, ) -> Handle<'_, ProgressBar>

where L: Lens<Target = f32>,

Creates a new progress bar bound to the value targeted by the lens.

Example

ProgressBar::new(cx, AppData::value, Orientation::Horizontal);

pub fn horizontal<L>(cx: &mut Context, lens: L) -> Handle<'_, ProgressBar>

where L: Lens<Target = f32>,

Creates a new horizontal progress bar bound to the value targeted by the lens.

pub fn vertical<L>(cx: &mut Context, lens: L) -> Handle<'_, ProgressBar>

where L: Lens<Target = f32>,

Creates a new vertical progress bar bound to the value targeted by the lens.

Trait Implementations

impl View for ProgressBar

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css.

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>

where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view.

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view.

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view.

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)