74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
# spinoff
|
|
`spinoff` is a simple to use library for displaying spinners in the terminal, with plenty of features and options.
|
|
|
|
[](https://crates.io/crates/spinoff) [](https://crates.io/crates/spinoff) [](https://docs.rs/spinoff/latest/spinoff) [](https://crates.io/crates/spinoff) 
|
|
|
|
|
|
|
|
|
|
## ⚡ Usage
|
|
|
|
```rust
|
|
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
|
|
|
|
```rust
|
|
use spinoff::{Spinner, Spinners, Color};
|
|
use std::thread::sleep;
|
|
use std::time::Duration;
|
|
|
|
let mut spinner = Spinner::new(Spinners::Dots, "Loading...", Some(Color::Red));
|
|
sleep(Duration::from_secs(3));
|
|
spinner.update(Spinners::Dots2, "Loading...", None);
|
|
sleep(Duration::from_secs(3));
|
|
spinner.stop()
|
|
```
|
|
|
|
### Stop a spinner and persist a symbol and message
|
|
|
|
```rust
|
|
use spinoff::{Spinner, Spinners, Color};
|
|
use std::thread::sleep;
|
|
use std::time::Duration;
|
|
|
|
let mut spinner = Spinner::new(Spinners::Dots, "Loading...", Some(Color::Green));
|
|
sleep(Duration::from_secs(3));
|
|
spinner.stop_and_persist("📜", "Task done.");
|
|
```
|
|
|
|
Other examples can be found in the [documentation](https://docs.rs/spinoff/latest/spinoff/).
|
|
|
|
|
|
## 📖 Documentation
|
|
|
|
* All relevant documentation can be found on the [Docs.rs page](https://docs.rs/spinoff/latest/spinoff/).
|
|
* If you want to see all the available `Spinner` options, check the [`Spinners`](src/utils/spinner_enum.rs) enum.
|
|
|
|
## 🔨 Examples
|
|
|
|
To run some of the included examples, use:
|
|
```bash
|
|
cargo run --example all_spinners
|
|
```
|
|
|
|
```bash
|
|
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.](https://github.com/ad4mx/spinoff)
|
|
|
|
## 📑 License
|
|
|
|
This crate is licensed under the [MIT license](LICENSE).
|