Throbber widget of ratatui

NOTE: This crate was originally created as a widget for tui-rs, so you can see tui:: on the sample code, but (by default) ratatui is used, so please replace it accordingly.

throbber-widgets-tui is a ratatui (or tui-rs) widget that displays throbber.

A throbber may also be called:

• activity indicator
• indeterminate progress bar
• loading icon
• spinner
• ぐるぐる(guru guru)

Demo

The demo shown in the gif can be run with all available symbols.

cargo run --example demo --release

Features

• Render throbber
• With label
• Random or specified step, also negative is possible.

Getting Started

MSRV: throbber-widgets-tui requires rustc 1.72.0 or newer.

cargo add throbber-widgets-tui

Default is ratatui as tui.

cargo add throbber-widgets-tui --no-default-features --features tui

Example code:

#[cfg(feature = "ratatui")]
use ratatui as tui;
// :
// :
struct App {
    throbber_state: throbber_widgets_tui::ThrobberState,
}
impl App {
    fn on_tick(&mut self) {
        self.throbber_state.calc_next();
    }
}
// :
// :
// If use tui-rs or ratatui v0.23.0 or older, use bellow.
//fn ui<B: tui::backend::Backend>(f: &mut tui::Frame<B>, app: &mut App) {
#[cfg(feature = "ratatui")]
fn ui(f: &mut tui::Frame, app: &mut App) {
    let chunks = tui::layout::Layout::default()
        .direction(tui::layout::Direction::Horizontal)
        .margin(1)
        .constraints(
            [
                tui::layout::Constraint::Percentage(50),
                tui::layout::Constraint::Percentage(50),
            ]
            .as_ref(),
        )
        .split(f.size());

    // Simple random step
    let simple = throbber_widgets_tui::Throbber::default();
    f.render_widget(simple, chunks[0]);

    // Set full with state
    let full = throbber_widgets_tui::Throbber::default()
        .label("Running...")
        .style(tui::style::Style::default().fg(tui::style::Color::Cyan))
        .throbber_style(tui::style::Style::default().fg(tui::style::Color::Red).add_modifier(tui::style::Modifier::BOLD))
        .throbber_set(throbber_widgets_tui::CLOCK)
        .use_type(throbber_widgets_tui::WhichUse::Spin);
    f.render_stateful_widget(full, chunks[1], &mut app.throbber_state);
}

Apps using throbber-widgets-tui

• mntime: Execute "m" commands "n" times to calculate mean of usage time and memory. As an alternative to "time", "gnu-time" is used internally.

Dependencies (By default)

Direct dependencies crates:

cargo license --direct-deps-only --avoid-build-deps --avoid-dev-deps | awk -F ":" 'BEGIN {printf "|License|crate|\n|-|-|\n"} {printf "|%s|%s|\n", $1, $2}'

Chain dependencies crates:

cargo license --avoid-build-deps --avoid-dev-deps | awk -F ":" 'BEGIN {printf "|License|crate|\n|-|-|\n"} {printf "|%s|%s|\n", $1, $2}'

License

This repository's license is zlib. Please feel free to use this, but no warranty.