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

#980 in Command-line interface

Download history 7/week @ 2024-11-16 3/week @ 2024-11-23 65/week @ 2024-11-30 317/week @ 2024-12-07 78/week @ 2024-12-14 12/week @ 2024-12-21 348/week @ 2024-12-28 293/week @ 2025-01-04 21/week @ 2025-01-11 123/week @ 2025-01-18 627/week @ 2025-01-25 548/week @ 2025-02-01 268/week @ 2025-02-08 80/week @ 2025-02-15 13/week @ 2025-02-22 12/week @ 2025-03-01

432 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–21MB
~297K SLoC