raclettui 0.3.0

Build terminal-themed wayland layer shell applications with Rust.
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

<p align="center">
  <img src="assets/raclettuilogo.png" width="500" alt="raclettui logo">
</p>

<div align="center">

[![Crates.io](https://img.shields.io/crates/v/raclettui)](https://crates.io/crates/raclettui)
[![docs.rs](https://img.shields.io/docsrs/raclettui)](https://docs.rs/raclettui)
[![MIT/Apache 2.0](https://img.shields.io/crates/l/raclettui)](https://github.com/ishrut/raclettui)

</div>

# Raclettui

Build TUI (terminal user interface) windows on Wayland via the
layer-shell protocol. Powered by [Ratatui] and [beamterm-core].

## About

Raclettui creates `zwlr_layer_shell_v1` windows (overlays, panels, bars,
lock screens) and implements the Ratatui `Backend` trait so you can draw
terminal-style UIs with GPU-accelerated glyph rendering.

This project is still under active development — expect bugs and breaking
changes. It was developed to build a UI for the author's personal project
when no existing Rust layer-shell libraries fit their needs.

## Requirements

- A Wayland compositor that supports the
  [`zwlr_layer_shell_v1`](https://wayland.app/protocols/wlr-layer-shell-unstable-v1)
  protocol (e.g. Sway, Hyprland, River)
- OpenGL 3.3+ / EGL
- `fontconfig` (for monospace font discovery)

## Usage

Add the dependency:

```sh
cargo add raclettui
```

Minimal example:

```rust no_run
use raclettui::{
    WindowBuilder, KeyCode, WindowEvent,
    layer_shell::KeyboardInteractivity,
};
use ratatui::{Terminal, widgets::Paragraph};

fn main() {
    let window = WindowBuilder::default()
        .set_keyboard_interactivity(KeyboardInteractivity::OnDemand)
        .build()
        .expect("failed to create window");

    let events = window.events();
    let mut terminal = Terminal::new(window).unwrap();

    loop {
        terminal
            .draw(|f| {
                f.render_widget(Paragraph::new("Hello 👋"), f.area());
            })
            .unwrap();

        for ev in events.drain() {
            if let WindowEvent::Keyboard(k) = ev {
                if matches!(k.code, KeyCode::Esc | KeyCode::Char('q')) {
                    return;
                }
            }
        }
    }
}
```

See [examples/hello.rs](examples/hello.rs) for a more complete example.

## Documentation

Full API documentation: <https://docs.rs/raclettui>

## Contributing

Pull requests are welcome! See the [todo list](./TODO.md).

## License

Licensed under either of

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

at your option.

[Ratatui]: https://ratatui.rs
[beamterm-core]: https://github.com/junkdog/beamterm