rat-salsa

Crates.iorat-salsa
lib.rsrat-salsa
version4.0.2
created_at2024-06-10 18:29:37.64972+00
updated_at2026-01-06 08:20:30.557869+00
descriptionratatui widgets and a crossterm event-loop
homepage
repositoryhttps://github.com/thscharler/rat-salsa
max_upload_size
id1267458
size427,603
(thscharler)

documentation

README

semver stable crates.io Documentation License License

rat-salsa 2

Runs an application event-loop for ratatui and crossterm.

It can

All incoming events are converted to an application defined event-type, and are distributed by calling an event-handler function. This function returns a control-flow which dictates further actions.

Changes

Changes

Book

link

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 Focus-handling for widgets.
    • rat-reloc Relocate a widgets state after rendering. This is needed to support view-like widgets.
    • rat-scrolled Utility widgets for scrolling.
    • rat-popup Utility widget to help with popups.
    • rat-dialog Stacks windows/dialogs above the main application.

    Crates for specific 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. experimental

    And my 10ct on theming.

    • rat-theme2 Color-palettes and widget styles.
    • rat-theme4 Latest iteration. Move to a map of things.
      • better text-color support
      • support for deriving themes by modifying existing ones.

Example

The examples directory contains some examples

There are some templates too

  • minimal.rs: Minimal application with a menubar and statusbar.
  • nominal.rs: Minimal application, but using subcomponents.
  • dialog.rs: Minimal application, using dialog windows.

image image

Commit count: 3278

cargo fmt