Go to file
2022-07-18 16:40:52 +02:00
.github new: Issue templates 2022-07-15 21:31:40 +02:00
assets fix: edited gif 2022-07-18 10:48:01 +02:00
examples fix: fix README code examples 2022-07-18 10:54:02 +02:00
src chore: removed some whitespace 2022-07-18 09:27:54 +02:00
.gitignore Initial commit 2022-07-15 19:59:22 +02:00
Cargo.toml fix: fix README 2022-07-17 14:24:43 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-07-18 16:40:52 +02:00
LICENSE Initial commit 2022-07-15 19:59:22 +02:00
README.md fix: spiced up readme.md 2022-07-18 16:36:10 +02:00

spinoff

spinoff is a simple to use library for displaying spinners in the terminal, with plenty of features and options.

Version Downloads Docs




Usage

use spinoff::{Spinner, Spinners, Color};
use std::thread::sleep;
use std::time::Duration;

let spinner = Spinner::new(Spinners::Dots, "Loading...", Some(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::Dots, "Loading...", Some(Color::Blue)); 
sleep(Duration::from_secs(3));
spinner.update(Spinners::Dots2, "Loading...", None);
sleep(Duration::from_secs(3));
spinner.stop_and_persist("👨‍💻", "Done!");

📖 Documentation

  • All relevant documentation can be found on the Docs.rs page.
  • If you want to see all the available Spinner options, check the Spinners enum.

🔨 Examples

To run some of the included examples, use:

cargo run --example all_spinners
cargo run --example simple

🚧 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.