spinoff

an easy to use, robust library for displaying spinners in the terminal

🔨 Install

Add as a dependency to your Cargo.toml:

toml [dependencies] spinoff = "0.8.0"

⚡ Usage

```rust 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

```rust 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::fromsecs(3)); spinner.update(Spinners::Dots2, "Retrying...", None); sleep(Duration::fromsecs(3)); spinner.stop() ```

Specify an output stream

```rust use spinoff::{Spinner, spinners, Color, Streams}; use std::thread::sleep; use std::time::Duration;

let mut spinner = Spinner::newwithstream(spinners::Line, "Loading...", Color::Yellow, Streams::Stderr); sleep(Duration::fromsecs(3)); spinner.stopand_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:

toml [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:

```rust 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: rust 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 the spinner module.

⚙ Examples

bash cargo run --example simple bash cargo run --example stream bash 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.