11 stable releases (3 major)
new 6.2.0 | Jan 6, 2025 |
---|---|
6.1.0 | Jan 2, 2025 |
5.0.2 | Jan 2, 2025 |
5.0.0 | Dec 31, 2024 |
3.3.1 | Dec 29, 2024 |
#700 in Command line utilities
965 downloads per month
23KB
490 lines
cool-rust-input
an input crate for fine control over each key press and rendering of text. by default allows multiline input, but custom behaviour can be added to make enter submit.
cross platform, tested on windows 11, arch and termux.
basic code sample
use cool_rust_input::{CoolInput, DefaultInputHandler};
fn main() -> Result<(), std::io::Error> {
let mut my_input = CoolInput::new(DefaultInputHandler, 0);
my_input.listen()?;
Ok(())
}
custom handler sample
use cool_rust_input::{
set_terminal_line, CoolInput, CustomInputHandler, HandlerContext, InputTransform,
};
use crossterm::{
queue,
style::{Color, SetForegroundColor},
};
use std::io::stdout;
struct MyHandler;
impl CustomInputHandler for MyHandler {
fn get_input_transform(&mut self, ctx: HandlerContext) -> InputTransform {
let size = (ctx.terminal_size.0 - 10, ctx.terminal_size.1 - 2);
let offset = (5, 2);
InputTransform { size, offset }
}
fn after_draw_text(&mut self, _: HandlerContext) {
// we'll use this function to display a title text
let _ = queue!(stdout(), SetForegroundColor(Color::Green));
let _ = set_terminal_line("[MY COOL TEXT EDITOR PROGRAM]", 5, 0, true);
}
}
fn main() -> Result<(), std::io::Error> {
let mut my_input = CoolInput::new(MyHandler, 0);
my_input.listen()?;
Ok(())
}
todo:
- markdown support (to some degree) (maybe)
- pgdown/pgup
- ctrl + left/right arrow
Dependencies
~2–11MB
~133K SLoC