zenity 3.2.0

100+ spinner animations and Progress Bars and Support for Multiple Animations at Once
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

<div align="center">
  <img src="images/ZENITY.svg" alt="Zenity svg logo" width="400">
<p>Yet Another Spinner Lib</p>
<p style="margin-top: -10px;">Elevate your Rust command-line interfaces with 100+ spinner animations and Progress Bars + multiline support</p>
  <a href="https://github.com/Arteiii/zenity/actions/workflows/publish_crate.yml">
    <img src="https://github.com/Arteiii/zenity/actions/workflows/publish_crate.yml/badge.svg" alt="Publish to Crates">
  </a>
  <a href="https://github.com/Arteiii/zenity/actions/workflows/release_examples.yml">
    <img src="https://github.com/Arteiii/zenity/actions/workflows/release_examples.yml/badge.svg" alt="Compile Rust">
  </a>
  <img src="https://img.shields.io/crates/v/zenity" alt="Crates.io Version">
  <img src="https://img.shields.io/docsrs/zenity" alt="docs.rs">
  <br>
  <a href="https://www.codefactor.io/repository/github/arteiii/zenity">
    <img src="https://www.codefactor.io/repository/github/arteiii/zenity/badge" alt="CodeFactor">
  </a>
  <a href="https://codecov.io/gh/Arteiii/zenity" > 
    <img src="https://codecov.io/gh/Arteiii/zenity/graph/badge.svg?token=CHEG2ZD0LW" alt="codecov badge"/> 
  </a>
</div>

![progress bar](images/rustrover64_WupAJU44Lu.gif)

![multiline preview](images/rustrover64_4bzlv2mWxK.gif)

![menu input preview](images/rustrover64_Qgn5icero6.gif)

Do you often find yourself gazing into the void of your terminal,  
wondering if your computer has decided to take a coffee break without notifying you?

100+ predefined animations

- [Spinner](https://docs.rs/zenity/latest/zenity/spinner/frames/struct.Frames.html)
- [ProgressBar](https://docs.rs/zenity/latest/zenity/progress/frames/struct.Frames.html)

## How to Use?

It's as easy as pie (or maybe even easier, depending on your pie-making skills)!  
Follow these simple steps:

````shell
cargo add zenity
````

```rust
// example/basic.rs

use std::thread::sleep;
use std::time::Duration;
use zenity::spinner::MultiSpinner;

fn main() {
    // create a LoadingAnimation instance using one of the predefined animations
    let spinner = MultiSpinner::default();
    sleep(Duration::from_secs(5));

    // optional:
    // set the text to "Loading..."
    spinner.set_text(&spinner.get_last(), "  Loading...".to_string());

    sleep(Duration::from_secs(500));
    // `loading_animation` will run out of scope now and get dropped,
    // thus the animation will stop and remove itself from the console
}
```

check out the examples for more

**NOTE:**

- the lib already includes checks for `--color` following the conventions
  by:
  [Rain's Rust CLI recommendations](https://rust-cli-recommendations.sunshowers.io/colors.html#general-recommendations)

## Documentation

Documentation
You can access the general documentation for the latest crate online
at [docs.rs](https://docs.rs/zenity/latest/zenity/).  
For more detailed information, navigate to the [modules section](https://docs.rs/zenity/latest/zenity/#modules).

Alternatively, you can view the documentation locally by running the following command:

```shell
cargo doc --open -p zenity
```

The styles provided are reexports of crossterm,
which you can find [here](https://docs.rs/crossterm/latest/crossterm/style/index.html).

### Examples

For a list of examples you can run, execute the following command:

```shell
cargo run --example
```

## Contributing

Contributions, bug reports, feature requests, and suggestions are all welcome!

If you encounter any issues or have ideas for improvements, please don't hesitate to open
an [issue on GitHub](https://github.com/Arteiii/zenity/issues/new).  
[Pull requests](https://github.com/Arteiii/zenity/pulls) are also highly appreciated.  
If you find this project helpful or enjoyable, consider giving it a star on [GitHub](https://github.com/Arteiii/zenity).

Thank you for your interest and contributions!

## Disclaimer

Now, we won't promise you that cli_loading_magic will solve all your problems.  
We can't guarantee it won't crash your terminal or cause your computer to sprout legs and walk away in protest.

But hey, life's an adventure, right?

Embrace the chaos, enjoy the ride, and remember:  
if all else fails, there's always **Ctrl+C.**

## Credits

This project wouldn't have been possible without the amazing work of the following projects:

- [Crossterm](https://github.com/crossterm-rs/crossterm)
- [supports_color](https://docs.rs/supports-color/latest/supports_color/)

## License

This project is licensed under the **DWFYW** License.

For more information, see the [LICENSE](LICENSE) file.