modalx 0.1.1

A polished, modal-driven terminal UI framework for Rust featuring dynamic boxed frames, interactive forms, and context-aware shortcuts.
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

# TableModal

`TableModal` provides a structured, multi-column tabular data browser. It supports custom column alignments (Left, Center, Right), column width allocations, interactive row selection, and viewport pagination.

---

## Visual Presentation

```
╭──────────────────────────────────────────────────────────────────────────────╮
│                           ACTIVE PROCESS INSPECTOR                           │
├──────────────────────────────────────────────────────────────────────────────┤
│     PID  Process Name               Memory (MB)     CPU (%)  Status          │
├──────────────────────────────────────────────────────────────────────────────┤
│    1042  systemd                           48.2         0.1  Running         │
│  > 2180  dockerd                          312.5         1.4  Running         │
│    3401  postgres                         524.8         2.1  Running         │
│    4892  redis-server                      84.1         0.3  Running         │
│    5110  nginx                             32.0         0.2  Running         │
│    6720  worker-pool                       41.6         0.0  Running         │
├──────────────────────────────────────────────────────────────────────────────┤
│  [↑/↓/j/k] Move  |  [Enter] Select Row  |  [Esc] Dismiss                     │
╰──────────────────────────────────────────────────────────────────────────────╯
```

---

## Basic Usage

```rust
use modalx::prelude::*;

fn main() -> modalx::Result<()> {
    let mut selected_row = 0;

    let columns = vec![
        TableColumn::new("PID", 8).right_aligned(),
        TableColumn::new("Process Name", 24),
        TableColumn::new("Memory (MB)", 14).right_aligned(),
        TableColumn::new("CPU (%)", 10).right_aligned(),
        TableColumn::new("Status", 12),
    ];

    let rows = vec![
        vec!["1042".into(), "systemd".into(), "48.2".into(), "0.1".into(), "Running".into()],
        vec!["2180".into(), "dockerd".into(), "312.5".into(), "1.4".into(), "Running".into()],
        vec!["3401".into(), "postgres".into(), "524.8".into(), "2.1".into(), "Running".into()],
        vec!["4892".into(), "redis-server".into(), "84.1".into(), "0.3".into(), "Running".into()],
    ];

    let modal = TableModal::new("ACTIVE PROCESS INSPECTOR")
        .with_columns(columns)
        .with_rows(rows)
        .with_selectable(true);

    match modal.run(&mut selected_row)? {
        TableOutcome::Selected(row_idx) => {
            println!("Selected process at row {}", row_idx);
        }
        TableOutcome::Cancelled => {
            println!("Inspector dismissed.");
        }
    }

    Ok(())
}
```

---

## Column Alignment & Width Accounting

Each column is configured through `TableColumn`:

```rust
pub struct TableColumn {
    pub header: String,
    pub width: usize,
    pub align: ColumnAlign,
}
```

### Alignment Modes

- **Left Aligned** (`TableColumn::new(header, width)`): Best for strings, names, identifiers, and file paths. Text is left-justified and padded with spaces to the right.
- **Right Aligned** (`.right_aligned()`): Essential for numbers, currency, timestamps, and percentages, ensuring decimal points and digits align visually down the column.
- **Center Aligned** (`.center_aligned()`): Suitable for status badges (e.g. `[OK]`, `RUNNING`, `PAUSED`).

---

## Selection Modes

`TableModal` can be used in two modes:

1. **Selectable Mode** (`.with_selectable(true)`):
   - A selection cursor (`> `) highlights the active row in bold or cyan.
   - Up and down arrows navigate rows.
   - Pressing `Enter` returns `TableOutcome::Selected(usize)` with the chosen row index.
2. **Read-Only Mode** (`.with_selectable(false)`):
   - Used for purely informational tables.
   - No selection cursor is rendered.
   - Pressing `Enter`, `Space`, or `Esc` dismisses the table.