13 releases (7 breaking)
0.8.0 | Nov 2, 2024 |
---|---|
0.7.1 | Oct 13, 2024 |
0.6.0 | Jun 29, 2024 |
0.5.0 | Mar 29, 2024 |
0.1.3 | Nov 9, 2022 |
#63 in Command line utilities
11,894 downloads per month
Used in 15 crates
(12 directly)
70KB
388 lines
Throbber widget of ratatui
NOTE: If you want to use tui-rs instead of ratatui, please use 0.4.1 or older version.
throbber-widgets-tui
is a ratatui 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.74.0 or newer.
cargo add throbber-widgets-tui
Example code:
// :
// :
struct App {
throbber_state: throbber_widgets_tui::ThrobberState,
}
impl App {
fn on_tick(&mut self) {
self.throbber_state.calc_next();
}
}
// :
// :
fn ui(f: &mut ratatui::Frame, app: &mut App) {
let chunks = ratatui::layout::Layout::default()
.direction(ratatui::layout::Direction::Horizontal)
.margin(1)
.constraints(
[
ratatui::layout::Constraint::Percentage(50),
ratatui::layout::Constraint::Percentage(50),
]
.as_ref(),
)
.split(f.area());
// 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(ratatui::style::Style::default().fg(ratatui::style::Color::Cyan))
.throbber_style(ratatui::style::Style::default().fg(ratatui::style::Color::Red).add_modifier(ratatui::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}'
License | crate |
---|---|
Apache-2.0 OR MIT (1) | rand |
MIT (1) | ratatui |
Zlib (1) | throbber-widgets-tui |
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 | crate |
---|---|
(MIT OR Apache-2.0) AND Unicode-DFS-2016 (1) | unicode-ident |
Apache-2.0 OR Apache-2.0 WITH LLVM-exception OR MIT (3) | linux-raw-sys, rustix, wasi |
Apache-2.0 OR BSD-2-Clause OR MIT (2) | zerocopy, zerocopy-derive |
Apache-2.0 OR BSL-1.0 (1) | ryu |
Apache-2.0 OR MIT (51) | allocator-api2, bitflags, cassowary, cfg-if, either, equivalent, errno, getrandom, hashbrown, heck, hermit-abi, indoc, itertools, itoa, libc, lock_api, log, parking_lot, parking_lot_core, paste, ppv-lite86, proc-macro2, quote, rand, rand_chacha, rand_core, rustversion, scopeguard, signal-hook, signal-hook-mio, signal-hook-registry, smallvec, static_assertions, syn, unicode-segmentation, unicode-truncate, unicode-width, unicode-width, winapi, winapi-i686-pc-windows-gnu, winapi-x86_64-pc-windows-gnu, windows-sys, windows-targets, windows_aarch64_gnullvm, windows_aarch64_msvc, windows_i686_gnu, windows_i686_gnullvm, windows_i686_msvc, windows_x86_64_gnu, windows_x86_64_gnullvm, windows_x86_64_msvc |
MIT (11) | castaway, compact_str, crossterm, crossterm_winapi, instability, lru, mio, ratatui, redox_syscall, strum, strum_macros |
MIT OR Unlicense (1) | byteorder |
Zlib (2) | foldhash, throbber-widgets-tui |
License
This repository's license is zlib. Please feel free to use this, but no warranty.
Dependencies
~6MB
~94K SLoC