rat-salsa 0.30.2

ratatui widgets and a crossterm event-loop
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

![stable](https://img.shields.io/badge/stability-RC--1-850101)
[![crates.io](https://img.shields.io/crates/v/rat-salsa.svg)](https://crates.io/crates/rat-salsa)
[![Documentation](https://docs.rs/rat-salsa/badge.svg)](https://docs.rs/rat-salsa)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![License](https://img.shields.io/badge/license-APACHE-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![](https://tokei.rs/b1/github/thscharler/rat-salsa)

# rat-salsa


An application event-loop with ratatui and crossterm.

![image][refMDEditGif]

rat-salsa provides

- application event loop [run_tui]
    - [background tasks](AppContext::spawn)
    - [background async tasks](AppContext::spawn_async)
    - [timers](AppContext::add_timer)
    - crossterm
    - [messages](AppContext::queue)
    - [focus](AppContext::focus)
    - [control-flow](Control)
- traits for
    - [AppWidget]
    - [AppState]

## Changes


[Changes](https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/changes.md)

## Book


For a start you can have a look at the [book][refRSBook].

## Companion Crates


* [rat-widget](https://docs.rs/rat-widget)
  widget library. Incorporates everything below, but each crate
  can be used on its own too.

  Foundational crates:

    * [rat-event](https://docs.rs/rat-event)
      Defines the primitives for event-handling.
    * [rat-cursor](https://docs.rs/rat-cursor)
      Defines just one trait to propagate the required screen cursor position.
    * [rat-focus](https://docs.rs/rat-focus)
      Primitives for focus-handling.
    * [rat-reloc](https://docs.rs/rat-reloc)
      Relocate widgets after rendering. Needed support for view-like widgets.
    * [rat-scrolled](https://docs.rs/rat-scrolled)
      Utility widgets for scrolling.
    * [rat-popup](https://docs.rs/rat-popup)
      Utility widget to help with popups.

  Crates that deal with specific categories of widgets.

    * [rat-ftable](https://docs.rs/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](https://docs.rs/rat-menu)
      Menu widgets.
    * [rat-text](https://docs.rs/rat-text)
      Text/Value input widgets.

  And my 10ct on theming.

    * [rat-theme](https://docs.rs/rat-theme)
      Color-palettes and widget styles.

* [rat-window](https://github.com/thscharler/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

- [files.rs][refFiles]: Minimal filesystem browser.
- [mdedit.rs][refMDEdit]: Minimal markdown editor.
- [life.rs][refLife]: Game of Life.

There are some starters too

- [minimal.rs][refMinimal]: Minimal application with a menubar and statusbar.
- [ultra.rs][refUltra]: Absolute minimum setup.

![image][refFilesGif]


[refFilesGif]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/files.gif?raw=true

[refMDEditGif]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/mdedit.gif?raw=true

[refLife]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/examples/life.rs

[refMDEdit]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/examples/mdedit.rs

[refFiles]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/examples/files.rs

[refMinimal]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/examples/minimal.rs

[refUltra]: https://github.com/thscharler/rat-salsa/blob/master/rat-salsa/examples/ultra.rs

[refRSBook]: https://thscharler.github.io/rat-salsa/