README.md

ratatui-eventInput

Unifies input handling from crossterm, termion and termwiz.

It is meant to be used by ratatui libraries to make input handling easier, or allow people using a library to specify what input to listen to.

Basic usage

The default backend is crossterm, if you want to use a different one you need to enable the feature for it:

ratatui-eventInput = {
    version = "0.1", 
    features = [
        "crossterm", 
        "termion", 
        "termwiz"
    ] }

After that just use a function like this to handle the input:

use ratatui_eventInput::{Input, Key};

pub fn handle<I: Into<Input>>(&mut self, input: I) {
    let input: Input = input.into()
    if input.key == Key::Right {
        println!("right")
    } else if input.key == Key::Left {
        println!("left")
    }
}

Acknowledgments

This library does not support all inputs the backends give and is mostly based on the inputs that crossterm uses.