uxterm 1.1.0

A user experience-focused terminal UI library built with Crossterm.
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

# uxterm

**uxterm** is a user experience-focused terminal UI (TUI) library for Rust, built on top of [Crossterm](https://crates.io/crates/crossterm). It provides a simple, modular system for building interactive terminal interfaces with checkboxes, sliders, buttons, and labels — all with clean input handling and cross-platform rendering.

---

## ✨ Features

- ✅ Easy-to-use widget system
- ✅ Checkbox, slider, button, and label components
- ✅ Keyboard navigation with TAB, SPACE, +/-, and ESC
- ✅ Blocking input with smooth key handling (no double toggles!)
- ✅ Cross-platform rendering (macOS, Windows, Linux)
- ✅ Return value system for collecting user input

---

## 🚀 Getting Started

Add `uxterm` to your `Cargo.toml`:

```toml
[dependencies]
uxterm = "1.1.0"
```

Then build your UI:

```rust
use uxterm::*;

fn main() -> std::io::Result<()> {
    let mut view = View::new("Ice Cream Selector");

    view.add(Label::new("Choose your ice cream flavours:"));
    view.add(Checkbox::new("Vanilla"));
    view.add(Checkbox::new("Chocolate"));
    view.add(Checkbox::new("Strawberry"));
    view.add(Checkbox::new("Mint"));
    view.add(Checkbox::new("Cookie Dough"));
    view.add(Label::new("Press TAB to switch, SPACE to toggle, ESC to finish"));

    let result = run(view)?;

    println!("\nYour ice cream will include:");
    for ingredient in result {
        println!("- {}", ingredient);
    }

    Ok(())
}
```

---

## 📦 Crate Info

- **Author**: [pjdur](https://github.com/pjdur)
- **Repository**: [github.com/pjdur/uxterm](https://github.com/pjdur/uxterm)
- **License**: MIT
- **Keywords**: `tui`, `terminal`, `ui`, `crossterm`, `ux`
- **Categories**: Command-line utilities, GUI, Development tools

---

## 🛠 Widgets

| Widget    | Description                          |
|-----------|--------------------------------------|
| `Label`   | Static text                          |
| `Checkbox`| Toggleable options                   |
| `Slider`  | Adjustable numeric input             |
| `Button`  | Clickable action (customizable)      |
| `Input`   | Text input field                     |

---

## 📣 Contributing

Pull requests, ideas, and feedback are welcome! Feel free to open an issue or fork the repo to experiment.

---

## 📜 License

Licensed under the [MIT License](./LICENSE.txt).