Crate rat_salsa

Current status: BETA

rat-salsa

An application event-loop with ratatui and crossterm.

rat-salsa provides

• application event loop run_tui
  • background tasks
  • timers
  • crossterm
  • messages
  • focus
  • control-flow
• traits for
  • AppWidget
  • AppState

Book

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

Companion Crates

• rat-widget widget library
• rat-scrolled utilities for scrolling. Included in rat-widget.
• 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. Included in rat-widget.
• rat-focus Primitives for focus-handling as used by rat-widget. Included in rat-widget.
• rat-event Defines the primitives for event-handling. Included in rat-widget.
• rat-theme Color-palettes and widget styles.

Example

The examples directory contains some examples

• files.rs: Minimal filesystem browser.
• mdedit.rs: Minimal markdown editor.
• life.rs: Game of Life.

There are some starters too

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

Modules

• event
  Event-handler traits and Keybindings.
• poll
  Defines the trait for event-sources.
• terminal
  Defines the trait RenderUI to hide the different rendering backends.
• timer
  Support for timers.

Structs

• AppContext
  Application context data.
• Cancel
  Type for cancellation.
• RenderContext
  Application context data when rendering.
• RunConfig
  Captures some parameters for crate::run_tui().

Enums

• Control
  Result of event-handling.

Traits

• AppState
  AppState packs together the currently supported event-handlers.
• AppWidget
  AppWidget mimics StatefulWidget and adds a RenderContext

Functions

• run_tui
  Run the event-loop