36 releases (6 stable)

1.0.5 Feb 10, 2025
1.0.1 Jan 31, 2025
0.37.2 Jan 29, 2025
0.32.0 Dec 29, 2024
0.13.0 Jul 3, 2024

#996 in Command-line interface

Download history 6/week @ 2024-11-15 4/week @ 2024-11-22 50/week @ 2024-11-29 290/week @ 2024-12-06 115/week @ 2024-12-13 14/week @ 2024-12-20 271/week @ 2024-12-27 362/week @ 2025-01-03 31/week @ 2025-01-10 122/week @ 2025-01-17 533/week @ 2025-01-24 585/week @ 2025-01-31 256/week @ 2025-02-07 149/week @ 2025-02-14 14/week @ 2025-02-21 13/week @ 2025-02-28

540 downloads per month
Used in 5 crates

MIT/Apache

1.5MB
38K SLoC

semver stable crates.io Documentation License License

This crate is a part of rat-salsa.

For examples see rat-widget GitHub

Rat Widgets

This crate tries to provide an extended set of widgets with

  • Event handling
  • Focus handling
  • Builtin scrolling
  • Speed

Event handling

Uses the trait defined in rat-event to implement event-handling for crossterm. All widgets are designed with other event-handlers in mind.

Focus handling

Uses FocusFlag defined by rat-focus internally, to mark the focused widget. This is just a passive flag, that probably can be used with other focus systems. Or you use rat-focus.

Scrolling

Where it makes sense the widgets implement internal scrolling. They use Scroll from rat-scrolled.

Speed

Rendering all the widgets tries hard not to need allocations and extensive copying during rendering.

Special mentions:

  • rat-ftable::Table: It uses an adapter for the data for rendering instead of creating Row/Cell structs.

Widgets

All the widgets are plain ratatui widgets, and implement StatefulWidget and the (experimental) StatefulWidgetRef traits.

Event handling uses rat-event::HandleEvent. Currently, crossterm events are implemented.

Layout

There are some layout calculators beyond ratatui's Layout.

Relocation

Widgets like View and Clipper move the widget-image after rendering. This breaks any areas stored in the widget-states.

reloc

Dependencies

~11–22MB
~296K SLoC