rat-focus 2.1.0

focus handling for ratatui widgets
Documentation

semver stable crates.io Documentation License License

This crate is a part of rat-salsa.

For examples see rat-focus GitHub.

Focus handling for ratatui

This crate works by adding a FocusFlag to each widget's state.

Then FocusBuilder is used to collect an ordered list of all widgets that should be considered for focus handling. It builds the Focus which has the functions next, prev and focus_at that can do the navigation.

from <focus_input1.rs>

fn focus_input(state: &mut State) -> Focus {
    let mut fb = FocusBuilder::default();
    fb.widget(&state.input1);
    fb.widget(&state.input2);
    fb.widget(&state.input3);
    fb.widget(&state.input4);
    fb.build()
}

fn handle_input(
    event: &crossterm::event::Event,
    _data: &mut Data,
    _istate: &mut MiniSalsaState,
    state: &mut State,
) -> Result<Outcome, anyhow::Error> {

    // Handle events for focus.
    let f = focus_input(state).handle(event, Regular);

    // ...

    Ok(f)
}
  • Keeps the focus-state close to the widgets code.
  • Rebuilt for each event.
    • No need to update the widget list when the application state changes.
    • FocusBuilder can be passed on all over the application to build the widget tree.