Crate rat_salsa

Source
Expand description

stable crates.io Documentation License License

§rat-salsa

An application event-loop with ratatui and crossterm.

image

rat-salsa provides

§Changes

Changes

§Book

For a start you can have a look at the book.

§Companion Crates

  • rat-widget widget library. Incorporates everything below, but each crate can be used on its own too.

    Foundational crates:

    • rat-event Defines the primitives for event-handling.
    • rat-cursor Defines just one trait to propagate the required screen cursor position.
    • rat-focus Primitives for focus-handling.
    • rat-reloc Relocate widgets after rendering. Needed support for view-like widgets.
    • rat-scrolled Utility widgets for scrolling.
    • rat-popup Utility widget to help with popups.

    Crates that deal with specific categories of widgets.

    • rat-ftable table. uses traits to render your data, and renders only the visible cells. this makes rendering effectively O(1) in regard to the number of rows.
    • rat-menu Menu widgets.
    • rat-text Text/Value input widgets.
    • rat-markdown Extension for TextArea for markdown.

    And my 10ct on theming.

    • rat-theme Color-palettes and widget styles.
  • rat-window Stopped for now. Implement windows in the tui. Can work with dyn StatefulWidgets too. The groundwork is done, but it’s missing a lot of implementation.

§Example

The examples directory contains some examples

There are some starters too

  • minimal.rs: Minimal application with a menubar and statusbar.
  • ultra.rs: Absolute minimum setup.

image

Modules§

poll
Event sources.
rendered
Rendered event.
terminal
rat-salsa’s own Terminal trait to hide some details.
thread_pool
Thread pool.
timer
Support for timers.

Structs§

AppContext
Application context for event handling.
RenderContext
Application context for rendering.
RunConfig
Captures some parameters for crate::run_tui().

Enums§

Control
Result enum for event handling.

Traits§

AppState
AppState executes events and has some init and error-handling.
AppWidget
AppWidget mimics StatefulWidget and adds a RenderContext
PollEvents
Trait for an event-source.

Functions§

run_tui
Run the event-loop