13 releases (7 breaking)
0.8.0 | Aug 4, 2023 |
---|---|
0.7.0 | Jan 29, 2023 |
0.6.0 | Jan 2, 2023 |
0.5.4 | Sep 11, 2022 |
0.5.3 | Jul 31, 2022 |
#90 in Command-line interface
12,150 downloads per month
Used in 30 crates
49KB
728 lines
spinoff
an easy to use, robust library for displaying spinners in the terminal
π¨ Install
Add as a dependency to your Cargo.toml
:
[dependencies]
spinoff = "0.8.0"
β‘ Usage
use spinoff::{Spinner, spinners, Color};
use std::thread::sleep;
use std::time::Duration;
let mut spinner = Spinner::new(spinners::Dots, "Loading...", Color::Blue);
sleep(Duration::from_secs(3));
spinner.success("Done!");
Update a spinner
use spinoff::{Spinner, spinners, Color};
use std::thread::sleep;
use std::time::Duration;
let mut spinner = Spinner::new(spinners::Aesthetic, "Loading...", Color::Red);
sleep(Duration::from_secs(3));
spinner.update(Spinners::Dots2, "Retrying...", None);
sleep(Duration::from_secs(3));
spinner.stop()
Specify an output stream
use spinoff::{Spinner, spinners, Color, Streams};
use std::thread::sleep;
use std::time::Duration;
let mut spinner = Spinner::new_with_stream(spinners::Line, "Loading...", Color::Yellow, Streams::Stderr);
sleep(Duration::from_secs(3));
spinner.stop_and_persist("π", "Task done.");
π« Spinners
spinoff
includes over 80+ spinner variants out of the box.
All spinner variants are treated as features that can be enabled or disabled. By default, all of them are enabled for ease of use.
To disable/enable variants, you will have to edit your cargo.toml
file:
[dependencies]
spinoff = { version = "0.8.0", features = ["dots", "arc", "line"] }
Any suggestions for new spinner variants are welcome.
Creating your own spinner
You can create your own spinner using the spinner!
macro:
use spinoff::*;
use std::thread::sleep;
use std::time::Duration;
let frames = spinner!([">", ">>", ">>>"], 100);
let mut sp = Spinner::new(frames, "Hello World!", None);
sleep(Duration::from_millis(800));
sp.stop();
βNote for Windows Users
For colors to work properly, you need to add a few extra lines to your code:
use colored::control
control::enable_virtual_terminal(true).unwrap();
π Documentation
- All relevant documentation can be found on the Docs.rs page.
- If you want to see all the available
spinner
options, refer to thespinner
module.
β Examples
cargo run --example simple
cargo run --example stream
cargo run --example stop_and_persist
Other examples can be found in the documentation.
π§ Contributing
Any contributions to this crate are highly appreciated. If you have any ideas/suggestions/bug fixes, please open an issue or a pull request. If you like the project, star this project on GitHub.
π License
This crate is licensed under the MIT license.
Dependencies
~0β10MB
~43K SLoC