🎇 Sparks

Beautiful TUI components for building terminal interfaces.

Components • Installation • Usage • Ecosystem

What is Sparks?

Sparks is the Rust equivalent of bubbles from Charmbracelet. It provides beautiful, ready-to-use TUI components that work standalone or with the Cauldron framework.

Components

use sparks::{Spinner, SpinnerStyle};

let mut spinner = Spinner::new(SpinnerStyle::Dots)
    .title("Loading...");
    
// In your render loop
spinner.tick();
println!("{}", spinner.view());

use sparks::{Progress, ProgressStyle};

let bar = Progress::new()
    .progress(0.6)
    .width(40)
    .style(ProgressStyle::BLOCK)
    .show_percentage();
    
println!("{}", bar.view());
// ████████████████████████░░░░░░░░░░░░░░░░  60%

use sparks::TextInput;

let mut input = TextInput::new()
    .placeholder("Enter your name...")
    .char_limit(50);
    
input.insert('H');
input.insert('i');
println!("{}", input.view());

use sparks::List;

let mut list = List::new([
    "Option A",
    "Option B", 
    "Option C",
]).height(5);

list.down(); // Move selection
println!("{}", list.view());

use sparks::Viewport;

let mut viewport = Viewport::new(80, 24);
viewport.set_content(long_text);

viewport.scroll_down(5);
viewport.page_down();
println!("{}", viewport.view());

use sparks::{Table, TableColumn};

let table = Table::new([
    TableColumn::new("Name"),
    TableColumn::new("Age"),
])
.row(["Alice", "30"])
.row(["Bob", "25"])
.selectable();

println!("{}", table.view());

use sparks::Tabs;

let mut tabs = Tabs::new(["Home", "Settings", "Help"]);
tabs.next(); // Switch tabs
println!("{}", tabs.view());
// Home | **Settings** | Help

Installation

cargo add sparks

Or add to your Cargo.toml:

[dependencies]
sparks = "0.1"

Spinner Styles

use sparks::SpinnerStyle;

SpinnerStyle::Dots      // ⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏
SpinnerStyle::Line      // | / - \
SpinnerStyle::Arrow     // ← ↖ ↑ ↗ → ↘ ↓ ↙
SpinnerStyle::Circle    // ◐ ◓ ◑ ◒
SpinnerStyle::Moon      // 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘
SpinnerStyle::Fire      // 🔥 🔥 ✨ 🔥

Progress Styles

use sparks::ProgressStyle;

ProgressStyle::BLOCK    // ████████░░░░
ProgressStyle::CLASSIC  // [========---]
ProgressStyle::THIN     // ━━━━━━━━────
ProgressStyle::CIRCLE   // ●●●●●●○○○○○○

With Cauldron

Sparks components work seamlessly with the Cauldron TUI framework:

use cauldron::{Model, Command};
use sparks::{Spinner, SpinnerStyle};

struct LoadingApp {
    spinner: Spinner,
}

impl Model for LoadingApp {
    type Message = ();

    fn update(&mut self, _: ()) -> Command<()> {
        self.spinner.tick();
        Command::none()
    }

    fn view(&self) -> String {
        self.spinner.view()
    }
}

Ecosystem

Sparks is part of the Molten Labs open source ecosystem:

Why "Sparks"?

Like sparks flying from the forge, these components are the bright, energetic building blocks that bring your terminal interfaces to life. 🎇

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

License

Licensed under either of:

• Apache License, Version 2.0 (LICENSE-APACHE)
• MIT license (LICENSE-MIT)

at your option.

_{Built with 🎇 by Molten Labs}