README.md

spinoff

simple library for displaying spinners in the terminal

🔨 Install

Add as a dependency to your Cargo.toml:

[dependencies]
spinoff = "0.7.0"

⚡ Usage

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

let 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 spinner = Spinner::new_with_stream(spinners::Line, "Loading...", Color::Yellow, Streams::Stderr);
sleep(Duration::from_secs(3));
spinner.stop_and_persist("📜", "Task done.");

💫 Spinners

Note: This has been introduced in version 0.7.0

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.7.0", features = ["dots, arc, line"] }

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 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();

Other examples can be found in the documentation.

📖 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 source code.

⚙ Examples

cargo run --example simple

cargo run --example stream

cargo run --example stop_and_persist

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