Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/etienne-napoleone/spinach
🥬 Practical spinner for Rust
https://github.com/etienne-napoleone/spinach
cli no-dependencies rust spinner terminal-ui
Last synced: about 1 month ago
JSON representation
🥬 Practical spinner for Rust
- Host: GitHub
- URL: https://github.com/etienne-napoleone/spinach
- Owner: etienne-napoleone
- License: gpl-3.0
- Created: 2022-03-22T12:03:03.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-28T15:34:36.000Z (almost 2 years ago)
- Last Synced: 2024-04-01T09:46:15.834Z (2 months ago)
- Topics: cli, no-dependencies, rust, spinner, terminal-ui
- Language: Rust
- Homepage: https://docs.rs/spinach/latest/spinach/
- Size: 137 KB
- Stars: 89
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-rust - etienne-napoleone/spinach - napoleone/spinach/actions/workflows/ci.yml/badge.svg)](https://github.com/etienne-napoleone/spinach/actions/workflows/ci.yml) (Libraries / Command-line)
- awesome-rust-cn - etienne-napoleone/spinach
README
# 🥬 spinach
[](https://crates.io/crates/spinach)
[](https://docs.rs/spinach)
[](LICENSE)
[](https://github.com/etienne-napoleone/spinach/actions/workflows/ci.yml)
> Practical spinner for Rust
## Install
Add as a dependency to your `Cargo.toml`.
```toml
[dependencies]
spinach = "2"
```
## Usage
Basic example.
```rust
use std::thread::sleep;
use std::time::Duration;
use spinach::Spinach;
fn main() {
let s = Spinach::new("Running task 1");
sleep(Duration::from_secs(1));
s.text("Running task 2");
sleep(Duration::from_secs(1));
s.succeed("Ran tasks successfully");
}
```
For general convenience, text can be passed as `String` or `&str`.
When an `Option`, can be passed as `String`, `&str` or `Option`
### Creating
```rust
use spinach::{Color, Spinach, Spinner};
// Using defaults + custom text
let s = Spinach::new("custom text");
// Using custom spinner
let spinner = Spinner::new(vec!["â–®","â–¯"], 80);
let s = Spinach::new_with(spinner, "custom text", Color::Red));
// Also with partial config (fallback to defaults)
let s = Spinach::new_with(None, "custom text", Color::Green);
```
### Updating
```rust
use spinach::{Color, Spinach};
let s = Spinach::new("custom text");
// Updating text
s.text("new text");
// Updating color
s.color(Color::White);
// Updating multiple
s.update_with("new text", Color::Red);
// Also with partial update (keep current)
s.update_with(None, Color::Red);
```
### Stopping
```rust
use spinach::{Color, Spinach};
let s = Spinach::new("custom text");
// Stop with final `✔` frame, green color and optional text change.
s.success("gg");
// Stop with final `✖` frame, red color and optional text change.
s.fail("ups");
// Stop with final `âš ` frame, yellow color and optional text change.
s.warn(None);
// Stop with final `ℹ` frame, blue color and optional text change.
s.info("notice");
// Stop current spinner (freeze the frame)
s.stop();
// Stopping with custom final frame, text and color
s.stop_with("🥬", "spinach'd", Color::Ignore);
// Also with partial update (keep current)
s.stop_with(None, None, Color::Blue);
```
### Freezing
Will freeze the current line with passed options and continue on a new line.
```rust
use spinach::{Color, Spinach};
let s = Spinach::new("Cutting spinaches");
// Similar to `stop_with`, but with an extra argument to change the spinner text.
s.freeze("🥬", "Spinaches cut", None, "Cutting carottes");
```
## FAQ
### How to avoid leaving terminal without prompt on interupt (ctrl^c)?
You can use a library like [`ctrlc`](https://crates.io/crates/ctrlc) to handle interupts.
The most basic way to handle it would be in conjuction with this lib QoL `show_cursor` function like this:
```rust
use spinach::{term, Spinach};
fn main() {
ctrlc::set_handler(|| {
term::show_cursor();
std::process::exit(0);
})
.expect("Error setting Ctrl-C handler");
let s = Spinach::new("spinnin'");
// ...
```
## Related
Inspired by:
- [ora](https://github.com/sindresorhus/ora)
- [spinners](https://github.com/FGRibreau/spinners)