Crate rat_cursor

source
Expand description

Current status: BETA

crates.io Documentation License License

This crate is a part of rat-salsa.

§Rat-Cursor

§Why?

This crate defines just the trait HasScreenCursor for use in other crates. This aims to overcome the shortcomings of ratatui to handle cursor positioning by widgets.

In the long run I hope there will be a solution within ratatui which will make this obsolete, but for now …

pub trait HasScreenCursor {
    fn screen_cursor(&self) -> Option<(u16, u16)>;
}

§Use

§Widget

This trait is implemented for the widget-state struct.

It’s implemented for the state struct because the widget might need to run the full layout process to know the cursor position. Which would approximately double the rendering process.

Instead of setting the cursor position during rendering somehow, the rendering process stores the cursor position in the state struct, where it can be retrieved later on.

The trait returns a screen-position, but only if it actually needs the cursor to be displayed:

  • The cursor is not scrolled off-screen.
  • The widget has some kind of input-focus.

§Container widget

A container widget can cascade down to its components.

ⓘ
    fn screen_cursor(&self) -> Option<(u16, u16)> {
    self.widget1.screen_cursor()
        .or(self.widget2.screen_cursor())
        .or(self.widget3.screen_cursor())
}

Traits§