Tuikit is a TUI library for writing terminal UI applications. Highlights:
- Thread safe.
- Support non-fullscreen mode as well as fullscreen mode.
- Support
Altkeys, mouse events, etc. - Buffering for efficient rendering.
Tuikit is modeld after termbox which views the terminal as a table of fixed-size cells and input being a stream of structured messages.
WARNING: The library is not stable yet, the API might change.
In your Cargo.toml add the following:
[dependencies]
tuikit = "*"And if you'd like to use the latest snapshot version:
[dependencies]
tuikit = { git = "https://github.com/lotabout/tuikit.git" }Here is an example (could also be run by cargo run --example hello-world):
use tuikit::prelude::*;
use std::cmp::{min, max};
fn main() {
let term: Term<()> = Term::with_height(TermHeight::Percent(30)).unwrap();
let mut row = 1;
let mut col = 0;
let _ = term.print(0, 0, "press arrow key to move the text, (q) to quit");
let _ = term.present();
while let Ok(ev) = term.poll_event() {
let _ = term.clear();
let _ = term.print(0, 0, "press arrow key to move the text, (q) to quit");
let (width, height) = term.term_size().unwrap();
match ev {
Event::Key(Key::ESC) | Event::Key(Key::Char('q')) => break,
Event::Key(Key::Up) => row = max(row-1, 1),
Event::Key(Key::Down) => row = min(row+1, height-1),
Event::Key(Key::Left) => col = max(col, 1)-1,
Event::Key(Key::Right) => col = min(col+1, width-1),
_ => {}
}
let attr = Attr{ fg: Color::RED, ..Attr::default() };
let _ = term.print_with_attr(row, col, "Hello World! 你好！今日は。", attr);
let _ = term.set_cursor(row, col);
let _ = term.present();
}
}tuikit provides HSplit, VSplit and Win for managing layouts:
HSplitallow you to split area horizontally into pieces.VSplitworks just likeHSplitbut splits vertically.Windo not split, it could have margin, padding and border.
For example:
use tuikit::prelude::*;
struct Model(String);
impl Draw for Model {
fn draw(&self, canvas: &mut dyn Canvas) -> Result<()> {
let (width, height) = canvas.size()?;
let message_width = self.0.len();
let left = (width - message_width) / 2;
let top = height / 2;
let _ = canvas.print(top, left, &self.0);
Ok(())
}
}
impl Widget for Model{}
fn main() {
let term: Term<()> = Term::with_height(TermHeight::Percent(50)).unwrap();
let model = Model("middle!".to_string());
while let Ok(ev) = term.poll_event() {
if let Event::Key(Key::Char('q')) = ev {
break;
}
let _ = term.print(0, 0, "press 'q' to exit");
let hsplit = HSplit::default()
.split(
VSplit::default()
.basis(Size::Percent(30))
.split(Win::new(&model).border(true).basis(Size::Percent(30)))
.split(Win::new(&model).border(true).basis(Size::Percent(30)))
)
.split(Win::new(&model).border(true));
let _ = term.draw(&hsplit);
let _ = term.present();
}
}The split algorithm is simple:
- Both
HSplitandVSplitwill take severalSplitwhere aSplitwould contains:- basis, the original size
- grow, the factor to grow if there is still enough room
- shrink, the factor to shrink if there is not enough room
HSplit/VSplitwill count the total width/height(basis) of the split items- Judge if the current width/height is enough or not for the split items
- shrink/grow the split items according to their grow/shrink:
factor / sum(factors) - If still not enough room, the last one(s) would be set width/height 0
Tuikit borrows ideas from lots of other projects:
- rustyline Readline Implementation in Rust.
- How to enter the raw mode.
- Part of the keycode parsing logic.
- termion A bindless library for controlling terminals/TTY.
- How to parse mouse events.
- How to enter raw mode.
- rustbox and termbox
- The idea of viewing terminal as table of fixed cells.
- termfest Easy TUI library written in Rust
- The buffering idea.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent