rattles - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #rust #deep-learning #linux #cli #kubernetes #awesome-list #pytorch #openai #mcp #open-source

rattles

(★ 998)

🪇 Minimal terminal spinners/throbbers for Rust

File Explorer

Download Latest Version (.zip)

- - demo.gif
- - rust.yml
- no_std.rs
- ratatui.rs
- showcase.rs
- - mod.rs
- clock.rs
- lib.rs
- macros.rs
- size.rs
- ticked.rs
- timed.rs
- util.rs
.gitignore
Cargo.lock
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
README.md

🚀 Installation Guide

1. Get the code

git clone https://github.com/vyfor/rattles

Downloads the entire project code from GitHub to your computer.

cd rattles

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo add rattles

Type this command into your terminal and run it.

cargo add rattles --no-default-features

Type this command into your terminal and run it.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🪇 Rattles

![Demo](https://raw.githubusercontent.com/vyfor/rattles/master/.github/assets/demo.gif)

**Rattles** is a minimal, dependency-free terminal spinner/throbber library for Rust. It makes no assumptions about how the output will be used.

## Quick Start

```sh
cargo add rattles
```

### Minimal example

```rust
use std::{io::Write, time::Duration};
use rattles::presets::prelude as presets;

fn main() {
    let rattle = presets::waverows();

// change default interval
    // let rattle = presets::waverows().set_interval(Duration::from_millis(100));

// reverse direction
    // let rattle = presets::waverows().reverse();

loop {
        print!("\r{}", rattle.current_frame());
        std::io::stdout().flush().unwrap();
        std::thread::sleep(Duration::from_millis(20));
    }
}
```

### Custom keyframes

```rust
rattle!(
    Custom, // struct name
    custom, // method name
    1,      // row count (width of the spinner)
    100,    // interval in milliseconds
    ["⣾", "⣷", "⣯", "⣟", "⣻", "⣽", "⣾"] // keyframes
)
```

### `no_std`

`rattles` enables the `std` feature by default. To opt out:

```sh
cargo add rattles --no-default-features
```

Without `std`, the global clock is unavailable. Animations can still be driven three ways:

- Time-based, with an external clock: 
    ```rs
    rattle.frame_at(elapsed)
    ```
- Index-based:
    ```rs
    rattle.frame(n)
    ```
- Tick-based:
    ```rust
    let mut rattle = presets::dots().into_ticked();
    rattle.tick();
    let frame = rattle.current_frame();
    ```
    Note that `TickedRattler` is stateful and must be stored outside the render loop.

## Presets

Built-in presets are organized by category:

- `presets::arrows`
- `presets::ascii`
- `presets::braille`
- `presets::emoji`

A prelude is available `rattles::prelude`.

## Examples

- a minimal ratatui [example](./examples/ratatui.rs)
- a no_std-oriented [example](./examples/no_std.rs)

## Acknowledgements

Rattles includes spinners sourced from these wonderful projects. We gratefully acknowledge their work.

- [sindresorhus/cli-spinners](https://github.com/sindresorhus/cli-spinners)
- [gunnargray-dev/unicode-animations](https://github.com/gunnargray-dev/unicode-animations)

## Licensing

Dual licensed under MIT OR Apache-2.0 at your discretion. See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.