├── .github
    └── workflows
    │   └── rust.yml
├── .gitignore
├── Cargo.toml
├── Makefile
├── README.md
├── crosstermion
    ├── CHANGELOG.md
    ├── Cargo.toml
    ├── LICENSE.md
    ├── Makefile
    ├── README.md
    └── src
    │   ├── color.rs
    │   ├── cursor.rs
    │   ├── input.rs
    │   ├── lib.rs
    │   └── terminal.rs
└── tui-react
    ├── .gitignore
    ├── CHANGELOG.md
    ├── Cargo.toml
    ├── LICENSE
    ├── README.md
    └── src
        ├── lib.rs
        ├── list.rs
        └── terminal.rs


/.github/workflows/rust.yml:
--------------------------------------------------------------------------------
 1 | name: Rust
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [main]
 6 |   pull_request:
 7 |     branches: [main]
 8 | 
 9 | jobs:
10 |   build-and-test:
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - uses: actions/checkout@v2
14 |       - name: fmt
15 |         run: cargo fmt --all -- --check
16 |       - name: clippy
17 |         run: cargo clippy
18 |       - name: tests
19 |         run: make tests
20 | 
21 |   build-and-test-on-windows:
22 |     name: Windows
23 |     runs-on: windows-latest
24 |     steps:
25 |       - uses: actions/checkout@v1
26 |       - uses: actions-rs/toolchain@v1
27 |         with:
28 |           profile: default
29 |           toolchain: stable
30 |           override: true
31 |       - name: tests
32 |         run: make tests-windows
33 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | 
 2 | # Created by https://www.gitignore.io/api/rust
 3 | # Edit at https://www.gitignore.io/?templates=rust
 4 | 
 5 | ### Rust ###
 6 | # Generated by Cargo
 7 | # will have compiled files and executables
 8 | /target/
 9 | 
10 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
11 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
12 | Cargo.lock
13 | 
14 | # These are backup files generated by rustfmt
15 | **/*.rs.bk
16 | 
17 | # End of https://www.gitignore.io/api/rust
18 | 


--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [workspace]
2 | members = ["crosstermion", "tui-react"]
3 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY : tests build
 2 | 
 3 | help:  ## Display this help
 4 | 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 5 | 
 6 | ##@ Testing
 7 | 
 8 | tests: ## Run all tests we have to assert quality
 9 | 	cd crosstermion && make check
10 | 	cd tui-react && cargo check
11 | 
12 | tests-windows: ## Run all tests that have a chance to work on windows
13 | 	cd crosstermion && make check-windows
14 | 	cd tui-react && cargo check
15 | 
16 | ##@ Maintenance
17 | clean: ## cargo clean on all crates
18 | 	cargo clean
19 | 
20 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # tui-crates
 2 | 
 3 | Various crates related to handling terminal user interfaces.
 4 | 
 5 | # Maintenance Notes
 6 | 
 7 | ## Upgrading TUI
 8 | 
 9 | 1. upgrade `tui` in `tui-react`, increment minor in `tui-react`  and `cargo publish`.
10 | 1. uprgade `tui` and `tui-react` in `crosstermion` and `cargo release`.
11 | 
12 | 
13 | ## Upgrading Crossterm
14 | 
15 | You can't - it comes as tui backend and thus we need tui to upgrade to the latest crossterm first.
16 | 


--------------------------------------------------------------------------------
/crosstermion/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Changelog
  2 | 
  3 | All notable changes to this project will be documented in this file.
  4 | 
  5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
  6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
  7 | 
  8 | ## 0.14.0 (2024-02-03)
  9 | 
 10 | ### Chore
 11 | 
 12 |  - <csr-id-ca29ee1037ed9a153c3d346c231e0562ee948467/> update ratatui to 0.26.0
 13 | 
 14 | ### New Features (BREAKING)
 15 | 
 16 |  - <csr-id-943d49d47c04c4ddf36b6ade8652d234d2235961/> update ratatui to 0.26.0
 17 | 
 18 | ### Commit Statistics
 19 | 
 20 | <csr-read-only-do-not-edit/>
 21 | 
 22 |  - 3 commits contributed to the release.
 23 |  - 38 days passed between releases.
 24 |  - 2 commits were understood as [conventional](https://www.conventionalcommits.org).
 25 |  - 0 issues like '(#ID)' were seen in commit messages
 26 | 
 27 | ### Commit Details
 28 | 
 29 | <csr-read-only-do-not-edit/>
 30 | 
 31 | <details><summary>view details</summary>
 32 | 
 33 |  * **Uncategorized**
 34 |     - Release tui-react v0.23.0, safety bump crosstermion v0.14.0 ([`c85ae46`](https://github.com/Byron/tui-crates/commit/c85ae466b18d6a97ddb45a7e2dce632d25ef971b))
 35 |     - Update ratatui to 0.26.0 ([`943d49d`](https://github.com/Byron/tui-crates/commit/943d49d47c04c4ddf36b6ade8652d234d2235961))
 36 |     - Update ratatui to 0.26.0 ([`ca29ee1`](https://github.com/Byron/tui-crates/commit/ca29ee1037ed9a153c3d346c231e0562ee948467))
 37 | </details>
 38 | 
 39 | ## 0.13.0 (2023-12-26)
 40 | 
 41 | ### New Features (BREAKING)
 42 | 
 43 |  - <csr-id-7b49dd81a3f7c209279e90c1110de00dfd6a0701/> upgrade to `ratatui` v0.25
 44 |  - <csr-id-2df671a3b4e33e3c960c91e6c10f9e8fe6c94a11/> Remove support for termion; use `crossterm` events directly.
 45 |    Also remove custom Key/Event abstractions and use the ones provided
 46 |    by `crossterm` instead. This is very much a breaking change,
 47 |    but requires only mechanical adjustments.
 48 | 
 49 | ### Commit Statistics
 50 | 
 51 | <csr-read-only-do-not-edit/>
 52 | 
 53 |  - 5 commits contributed to the release.
 54 |  - 19 days passed between releases.
 55 |  - 2 commits were understood as [conventional](https://www.conventionalcommits.org).
 56 |  - 0 issues like '(#ID)' were seen in commit messages
 57 | 
 58 | ### Commit Details
 59 | 
 60 | <csr-read-only-do-not-edit/>
 61 | 
 62 | <details><summary>view details</summary>
 63 | 
 64 |  * **Uncategorized**
 65 |     - Release crosstermion v0.13.0 ([`9555c6f`](https://github.com/Byron/tui-crates/commit/9555c6ff4b431316151ce3b81dd182d077031ab8))
 66 |     - Release tui-react v0.22.0, safety bump crosstermion v0.13.0 ([`b7283a5`](https://github.com/Byron/tui-crates/commit/b7283a511abadfdbbb6cfbb2832ee1d84c06815c))
 67 |     - Merge branch 'remove-termion' ([`c69813f`](https://github.com/Byron/tui-crates/commit/c69813f00e114313b206bceaa838e2fe0954f37b))
 68 |     - Upgrade to `ratatui` v0.25 ([`7b49dd8`](https://github.com/Byron/tui-crates/commit/7b49dd81a3f7c209279e90c1110de00dfd6a0701))
 69 |     - Remove support for termion; use `crossterm` events directly. ([`2df671a`](https://github.com/Byron/tui-crates/commit/2df671a3b4e33e3c960c91e6c10f9e8fe6c94a11))
 70 | </details>
 71 | 
 72 | ## 0.12.1 (2023-12-07)
 73 | 
 74 | ### New Features
 75 | 
 76 |  - <csr-id-5533fe6db074b0ba132ea01df41bde45182a4933/> replace `ansi-term` with `ansiterm`.
 77 |    One is maintained, the other one is not.
 78 | 
 79 | ### Commit Statistics
 80 | 
 81 | <csr-read-only-do-not-edit/>
 82 | 
 83 |  - 2 commits contributed to the release.
 84 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
 85 |  - 0 issues like '(#ID)' were seen in commit messages
 86 | 
 87 | ### Commit Details
 88 | 
 89 | <csr-read-only-do-not-edit/>
 90 | 
 91 | <details><summary>view details</summary>
 92 | 
 93 |  * **Uncategorized**
 94 |     - Release crosstermion v0.12.1 ([`7e7a324`](https://github.com/Byron/tui-crates/commit/7e7a324e094c121508adb1514b4aa39575f539aa))
 95 |     - Replace `ansi-term` with `ansiterm`. ([`5533fe6`](https://github.com/Byron/tui-crates/commit/5533fe6db074b0ba132ea01df41bde45182a4933))
 96 | </details>
 97 | 
 98 | ## 0.12.0 (2023-12-07)
 99 | 
100 | <csr-id-d337c866f48dda83166d8cafaaa97bbf24d69216/>
101 | <csr-id-a371272a96da49e8db82221eaf23d3aab38514d0/>
102 | 
103 | ### Chore
104 | 
105 |  - <csr-id-d337c866f48dda83166d8cafaaa97bbf24d69216/> upgrade all packages as long as they don't break the API
106 | 
107 | ### Chore (BREAKING)
108 | 
109 |  - <csr-id-a371272a96da49e8db82221eaf23d3aab38514d0/> upgrade `ratatui` to 0.24 and `crossterm` to v0.27.
110 |    Note that these two work together, and depend on each other.
111 | 
112 | ### Commit Statistics
113 | 
114 | <csr-read-only-do-not-edit/>
115 | 
116 |  - 4 commits contributed to the release.
117 |  - 210 days passed between releases.
118 |  - 2 commits were understood as [conventional](https://www.conventionalcommits.org).
119 |  - 0 issues like '(#ID)' were seen in commit messages
120 | 
121 | ### Commit Details
122 | 
123 | <csr-read-only-do-not-edit/>
124 | 
125 | <details><summary>view details</summary>
126 | 
127 |  * **Uncategorized**
128 |     - Release tui-react v0.21.0, crosstermion v0.12.0, safety bump crosstermion v0.12.0 ([`942f0b9`](https://github.com/Byron/tui-crates/commit/942f0b97a4b86b91e26530cca914906645f87ac4))
129 |     - Merge branch 'upgrades' ([`c6265c8`](https://github.com/Byron/tui-crates/commit/c6265c8773829f54e4acb1106d56ef2239edcab7))
130 |     - Upgrade `ratatui` to 0.24 and `crossterm` to v0.27. ([`a371272`](https://github.com/Byron/tui-crates/commit/a371272a96da49e8db82221eaf23d3aab38514d0))
131 |     - Upgrade all packages as long as they don't break the API ([`d337c86`](https://github.com/Byron/tui-crates/commit/d337c866f48dda83166d8cafaaa97bbf24d69216))
132 | </details>
133 | 
134 | ## 0.11.0 (2023-05-11)
135 | 
136 | <csr-id-073005de8c9177248528a4cc9be58d6cee525394/>
137 | 
138 | ### Chore (BREAKING)
139 | 
140 |  - <csr-id-073005de8c9177248528a4cc9be58d6cee525394/> switch to 'ratatui' in a fashion that leaves imports alone.
141 |    However would still be a breaking change for anyone leaving `tui` in
142 |    their dependency tree.
143 | 
144 | ### Commit Statistics
145 | 
146 | <csr-read-only-do-not-edit/>
147 | 
148 |  - 4 commits contributed to the release.
149 |  - 241 days passed between releases.
150 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
151 |  - 0 issues like '(#ID)' were seen in commit messages
152 | 
153 | ### Commit Details
154 | 
155 | <csr-read-only-do-not-edit/>
156 | 
157 | <details><summary>view details</summary>
158 | 
159 |  * **Uncategorized**
160 |     - Release tui-react v0.20.0, crosstermion v0.11.0, safety bump crosstermion v0.11.0 ([`6cc6346`](https://github.com/Byron/tui-crates/commit/6cc634618e1549fcece860b7b43f5d7ee5d1d259))
161 |     - Merge branch 'ratatui-2' ([`948b539`](https://github.com/Byron/tui-crates/commit/948b5397c0b8317e857f79515165c04314b6838a))
162 |     - Further updates to `crossterm` and `termion` ([`3157b3b`](https://github.com/Byron/tui-crates/commit/3157b3bf392b18f0f6be7e2c04d0b8782d76314e))
163 |     - Switch to 'ratatui' in a fashion that leaves imports alone. ([`073005d`](https://github.com/Byron/tui-crates/commit/073005de8c9177248528a4cc9be58d6cee525394))
164 | </details>
165 | 
166 | ## 0.10.1 (2022-09-12)
167 | 
168 | ### New Features
169 | 
170 |  - <csr-id-509c64c4918d7e1fbd462de5ec3ae83bf3329785/> Support for reseize events via the new `input_channel()` function.
171 |    Note that it only exists in blocking mode.
172 | 
173 | ### Commit Statistics
174 | 
175 | <csr-read-only-do-not-edit/>
176 | 
177 |  - 3 commits contributed to the release.
178 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
179 |  - 0 issues like '(#ID)' were seen in commit messages
180 | 
181 | ### Commit Details
182 | 
183 | <csr-read-only-do-not-edit/>
184 | 
185 | <details><summary>view details</summary>
186 | 
187 |  * **Uncategorized**
188 |     - Release crosstermion v0.10.1 ([`b1775e8`](https://github.com/Byron/tui-crates/commit/b1775e8da35f3df4f9e10af8f95b0931c1ee8d2b))
189 |     - Support for reseize events via the new `input_channel()` function. ([`509c64c`](https://github.com/Byron/tui-crates/commit/509c64c4918d7e1fbd462de5ec3ae83bf3329785))
190 |     - Cargo fmt ([`d31a4bd`](https://github.com/Byron/tui-crates/commit/d31a4bd53dde9db3160236ac132237f76513ad12))
191 | </details>
192 | 
193 | ## 0.10.0 (2022-09-12)
194 | 
195 | Upgrade to `tui` 0.19 and `crossterm` 0.25.
196 | 
197 | ### Commit Statistics
198 | 
199 | <csr-read-only-do-not-edit/>
200 | 
201 |  - 4 commits contributed to the release.
202 |  - 231 days passed between releases.
203 |  - 0 commits were understood as [conventional](https://www.conventionalcommits.org).
204 |  - 0 issues like '(#ID)' were seen in commit messages
205 | 
206 | ### Commit Details
207 | 
208 | <csr-read-only-do-not-edit/>
209 | 
210 | <details><summary>view details</summary>
211 | 
212 |  * **Uncategorized**
213 |     - Release crosstermion v0.10.0 ([`420d808`](https://github.com/Byron/tui-crates/commit/420d8087f49a87985d3331a384287481d43f1217))
214 |     - Update changelog prior to release ([`7e1330d`](https://github.com/Byron/tui-crates/commit/7e1330dfc070cd8c383d8b273622709e67a0c985))
215 |     - Upgrade to crossterm 25 and tui 19 ([`ec53e20`](https://github.com/Byron/tui-crates/commit/ec53e202e7fb1809b94de0b26a010f61704c6a74))
216 |     - Allow for the Resize event to happen ([`e49a08a`](https://github.com/Byron/tui-crates/commit/e49a08a9143e9d4684ffdf387face6cdb7b24367))
217 | </details>
218 | 
219 | ## 0.9.0 (2022-01-23)
220 | 
221 | ### New Features (BREAKING)
222 | 
223 |  - <csr-id-a3223b3d39cb71adb1b866653ee0c984924b90ca/> upgrade to tui 0.17
224 | 
225 | ### Commit Statistics
226 | 
227 | <csr-read-only-do-not-edit/>
228 | 
229 |  - 4 commits contributed to the release.
230 |  - 170 days passed between releases.
231 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
232 |  - 0 issues like '(#ID)' were seen in commit messages
233 | 
234 | ### Commit Details
235 | 
236 | <csr-read-only-do-not-edit/>
237 | 
238 | <details><summary>view details</summary>
239 | 
240 |  * **Uncategorized**
241 |     - Release crosstermion v0.9.0 ([`c5fc690`](https://github.com/Byron/tui-crates/commit/c5fc69022161e0abb2dd6c1402a606381ac2cce9))
242 |     - Upgrade to tui 0.17 ([`a3223b3`](https://github.com/Byron/tui-crates/commit/a3223b3d39cb71adb1b866653ee0c984924b90ca))
243 |     - Release tui-react v0.17.0 ([`4523678`](https://github.com/Byron/tui-crates/commit/4523678efbc9c876e46325682861c27ee5e7fb02))
244 |     - Use local tui-react crate ([`9281c8e`](https://github.com/Byron/tui-crates/commit/9281c8e65226ff3a34ade7b95ef96374c9a759ea))
245 | </details>
246 | 
247 | ## v0.8.1 (2021-08-05)
248 | 
249 | ### Commit Statistics
250 | 
251 | <csr-read-only-do-not-edit/>
252 | 
253 |  - 3 commits contributed to the release over the course of 1 calendar day.
254 |  - 1 day passed between releases.
255 |  - 0 commits were understood as [conventional](https://www.conventionalcommits.org).
256 |  - 0 issues like '(#ID)' were seen in commit messages
257 | 
258 | ### Commit Details
259 | 
260 | <csr-read-only-do-not-edit/>
261 | 
262 | <details><summary>view details</summary>
263 | 
264 |  * **Uncategorized**
265 |     - (cargo-release) version 0.8.1 ([`5fe230b`](https://github.com/Byron/tui-crates/commit/5fe230b6d85eaace655fad10ddac9608d2e62072))
266 |     - Fix apparently untested macr ([`c9ea9ac`](https://github.com/Byron/tui-crates/commit/c9ea9ac069ce7951252b3620052d611c925f6afd))
267 |     - Fix format ([`6323479`](https://github.com/Byron/tui-crates/commit/6323479162d69d22c55f4307be3eedd18c55f2af))
268 | </details>
269 | 
270 | ## v0.8.0 (2021-08-04)
271 | 
272 | * upgrade to TUI 0.16 and crossterm 0.20
273 | 
274 | ### Commit Statistics
275 | 
276 | <csr-read-only-do-not-edit/>
277 | 
278 |  - 5 commits contributed to the release over the course of 93 calendar days.
279 |  - 0 commits were understood as [conventional](https://www.conventionalcommits.org).
280 |  - 0 issues like '(#ID)' were seen in commit messages
281 | 
282 | ### Commit Details
283 | 
284 | <csr-read-only-do-not-edit/>
285 | 
286 | <details><summary>view details</summary>
287 | 
288 |  * **Uncategorized**
289 |     - Upgrade to crossterm 0.20 ([`1d31acb`](https://github.com/Byron/tui-crates/commit/1d31acbfde475ae42ac928d0e23ff950e669e2e7))
290 |     - Make CI work on windows ([`dc0e96f`](https://github.com/Byron/tui-crates/commit/dc0e96f982bf46c8b910ca316e92357c2091559b))
291 |     - Use a workspace ([`ccc5add`](https://github.com/Byron/tui-crates/commit/ccc5add08476a1910d8d78d3bb94b70237f50958))
292 |     - Changes repository paths in tui crates manifests ([`ac5c6e6`](https://github.com/Byron/tui-crates/commit/ac5c6e62c86189a72e2305d06da176821f88b180))
293 |     - Add tui crates ([`ccb6a24`](https://github.com/Byron/tui-crates/commit/ccb6a24315a7d881e50b24e98d4720406bff16d5))
294 | </details>
295 | 
296 | ## v0.7.0
297 | 
298 | * upgrade to TUI 0.15
299 | 
300 | ## v0.4.0
301 | 
302 | * upgrade to TUI 0.12
303 | 
304 | ## v0.3.2
305 | 
306 | * Remove `futures-util` dependency in favor of `futures-lite`
307 | 
308 | ## v0.2.0
309 | 
310 | * remove native support for `flume` and `crossbeam-channel` for key input in favor of `std::sync::mpsc::Receiver`s :).
311 | 
312 | ## v0.1.5
313 | 
314 | * support for simple cursor movements
315 | * get terminal size
316 | * color support to learn if color is allowed, and dynamically disable it
317 |   if `ansi_term` is used.
318 | 
319 | ## v0.1.4
320 | 
321 | * Fix precendence of imports in 'terminal' module.
322 | 
323 | ## v0.1.3
324 | 
325 | * `Key` type conversions are now always compiled when possible, as they are not mutually exclusive
326 | 
327 | ## v0.1.2
328 | 
329 | * Enable `flume/select` by default and allow selecting `flume/async` via the `flume-async` feature.
330 | 
331 | ## v0.1.1
332 | 
333 | * Add support for 'input-thread-flume' for using flume channels instead of crossbeam ones. They are
334 |   smaller and there is no unsafe code either, at the expense of lack of the 'select!()` capability.
335 | 
336 | ## v0.1.0
337 | 
338 | Initial release.
339 | 
340 | 


--------------------------------------------------------------------------------
/crosstermion/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "crosstermion"
 3 | version = "0.14.0"
 4 | authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
 5 | description = "utilities for `crossterm`, without ties to `termion`"
 6 | edition = "2018"
 7 | license = "MIT"
 8 | repository = "https://github.com/Byron/tui-crates"
 9 | readme = "README.md"
10 | include = ["src/**/*", "LICENSE.md", "README.md", "CHANGELOG.md"]
11 | 
12 | [features]
13 | default = []
14 | 
15 | color = ["ansiterm"]
16 | 
17 | input-async = ["futures-channel", "async-channel", "futures-lite", "futures-core" ]
18 | input-async-crossterm = ["crossterm/event-stream", "input-async"]
19 | 
20 | tui-crossterm = ["tui", "tui-crossterm-backend", "crossterm"]
21 | tui-react-crossterm = ["tui-react", "tui", "tui-crossterm-backend", "crossterm"]
22 | 
23 | tui-crossterm-backend = ["tui/crossterm"]
24 | 
25 | 
26 | [dependencies]
27 | crossterm = { version = "0.27.0", optional = true, default-features = false, features = ["events"] }
28 | futures-channel = { version = "0.3.5", optional = true, default-features = false, features = ["std", "sink"] }
29 | futures-core = { version = "0.3.5", optional = true, default-features = false }
30 | futures-lite = { version = "2.1.0", optional = true }
31 | tui = { package = "ratatui", version = "0.26.0", optional = true, default-features = false }
32 | tui-react = { version = "^0.23.2", optional = true, default-features = false, path = "../tui-react" }
33 | ansiterm = { version = "0.12.2", optional = true, default-features = false }
34 | async-channel = { version = "2.1.1", optional = true }
35 | 
36 | [target."cfg(windows)".dependencies]
37 | crossterm = { version = "0.27.0", optional = true, default-features = false, features = ["windows"] }
38 | 
39 | [package.metadata.docs.rs]
40 | all-features = true
41 | 


--------------------------------------------------------------------------------
/crosstermion/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | =====================
 3 | 
 4 | Copyright © `2020` `Sebastian Thiel`
 5 | 
 6 | Permission is hereby granted, free of charge, to any person
 7 | obtaining a copy of this software and associated documentation
 8 | files (the “Software”), to deal in the Software without
 9 | restriction, including without limitation the rights to use,
10 | copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | copies of the Software, and to permit persons to whom the
12 | Software is furnished to do so, subject to the following
13 | conditions:
14 | 
15 | The above copyright notice and this permission notice shall be
16 | included in all copies or substantial portions of the Software.
17 | 
18 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20 | OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22 | HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 | OTHER DEALINGS IN THE SOFTWARE.
26 | 


--------------------------------------------------------------------------------
/crosstermion/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY : tests build
 2 | 
 3 | help:  ## Display this help
 4 | 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
 5 | 
 6 | ##@ Testing
 7 | 
 8 | check: ## build features in commmon combination to be sure it all stays together
 9 | 	#if cargo check; then false; fi
10 | 	$(MAKE) check-windows
11 | 	cargo check --features color
12 | 	cargo check --all-features
13 | 
14 | 
15 | check-windows: ## build features in commmon combination to be sure it all stays together, crossterm only
16 | 	cargo check --features crossterm
17 | 	cargo check --features crossterm,input-async
18 | 	cargo check --features crossterm,tui
19 | 	cargo check --features tui-react-crossterm
20 | 	cargo check --features tui-react-crossterm,input-async
21 | 	cargo check --features tui-crossterm
22 | 	cargo check --features color
23 | 
24 | 


--------------------------------------------------------------------------------
/crosstermion/README.md:
--------------------------------------------------------------------------------
 1 | 
 2 | Crosstermion is a utility crate to unify some types of both crates, allowing to easily build apps that use the leaner `termion` 
 3 | crate on unix systems, but resort to crossterm on windows systems.
 4 | 
 5 | Currently provided facilities are:
 6 | 
 7 | * a `Key` type an an `input_stream` (_async_) to receive key presses
 8 | * an `AltenrativeRawTerminal` which marries an alternative screen with raw mode
 9 | * a way to create a `tui` or `tui-react` terminal with either the crossterm or the termion backend.
10 | 
11 | ### But how to do colors and styles?
12 | 
13 | * **With** `tui`
14 |     * When using the `tui`, you will have native cross-backend support for colors and styles.
15 | * **Without** `tui`
16 |     * Use the **`color`** feature for additional utilities for colors with `ansi_term`.
17 |     * Otherwise, using `ansi_term`, `colored` or `termcolor` will work as expected.
18 |       
19 | ### How to build with `crossterm` on Windows and `termion` on Unix?
20 | 
21 | There seems to be no easy way, as `cargo` will always build dependencies even though they are not supposed to be used on your platform.
22 | This leads to both `termion` and `crossterm` to be built, which is fatal on Windows. Thus one will have to manually select feature toggles
23 | when creating a release build, i.e. one would have to exclude all functionality that requires TUIs by default, and let the user enable
24 | the features they require.
25 | 
26 | The `compile_error!(…)` macro can be useful to inform users if feature selection is required. Alternatively, assure that everything compiles
27 | even without any selected backend.
28 | 
29 | Lastly, one can always give in and always compile against `crossterm`.
30 | 
31 | ### Features
32 | 
33 | All features work additively, but in case they are mutually exclusive, for instance
34 | in case of `tui-react` and `tui`, or `crossterm` and `termion`, the more general one will be chosen.
35 | 
36 | * _mutually exclusive_
37 |     * **crossterm**
38 |       * provides `Key` conversion support from `crossbeam::event::KeyEvent` and an `AlternativeRawTerminal`
39 |       * provides a threaded key input channel
40 |       * _additive_
41 |         * **input-async-crossterm**
42 |           * adds native async capabilites to crossterm, which works without spawning an extra thread thanks to `mio`.
43 |           * note that threaded key input is always supported.
44 |     * **termion**
45 |       * provides `Key` conversion support from `termion::event::Key` and an `AlternativeRawTerminal`
46 |       * provides a threaded key input channel
47 |       * _additive_
48 |         * **input-async**
49 |           * Spawn a thread and provide input events via a futures Stream
50 |           * note that threaded key input is always supported.
51 | * _mutually exclusive_
52 |     * _using `tui_` _(mutually exclusive)_
53 |         * **tui-termion** _implies `termion` feature_
54 |           * combines `tui` with `termion` and provides a `tui::Terminal` with `termion` backend
55 |         * **tui-crossterm**  _implies `crossterm` feature_
56 |           * combines `tui` with `crossterm` and provides a `tui::Terminal` with `crossterm` backend
57 |     * _using `tui-react`_ _(mutually exclusive)_
58 |         * **tui-react-termion** _implies `termion` feature_
59 |           * combines `tui-react` with `crossterm` and provides a `tui::Terminal` with `crossterm` backend
60 |         * **tui-react-crossterm** _implies `crossterm` feature_
61 |           * combines `tui-react` with `crossterm` and provides a `tui::Terminal` with `crossterm` backend
62 | * **color**
63 |    * Add support for `ansi_term` based conditional coloring. The crate is small, to the point and allows zero-copy drawing
64 |      of bytes and UTF-8 string, while supporting Windows 10 as well.
65 | * _cursor movement_
66 |    * _mutually exclusive_
67 |        * **crossterm**
68 |          * Implements cursor movement with crossterm
69 |        * **termion**
70 |          * Implements cursor movement with termion
71 | 
72 | 


--------------------------------------------------------------------------------
/crosstermion/src/color.rs:
--------------------------------------------------------------------------------
 1 | use std::borrow::Cow;
 2 | use std::ffi::OsStr;
 3 | 
 4 | #[cfg(feature = "ansiterm")]
 5 | mod _impl {
 6 |     use ansiterm::{ANSIGenericString, Style};
 7 | 
 8 |     pub struct Brush {
 9 |         may_paint: bool,
10 |         style: Option<Style>,
11 |     }
12 | 
13 |     impl Brush {
14 |         pub fn new(colored: bool) -> Self {
15 |             Brush {
16 |                 may_paint: colored,
17 |                 style: None,
18 |             }
19 |         }
20 | 
21 |         pub fn style(&mut self, style: Style) -> &mut Self {
22 |             self.style = Some(style);
23 |             self
24 |         }
25 | 
26 |         #[must_use]
27 |         pub fn paint<'a, I, S: 'a + ToOwned + ?Sized>(
28 |             &mut self,
29 |             input: I,
30 |         ) -> ANSIGenericString<'a, S>
31 |         where
32 |             I: Into<std::borrow::Cow<'a, S>>,
33 |             <S as ToOwned>::Owned: std::fmt::Debug,
34 |         {
35 |             match (self.may_paint, self.style.as_ref().take()) {
36 |                 (true, Some(style)) => style.paint(input),
37 |                 (_, Some(_)) | (_, None) => ANSIGenericString::from(input),
38 |             }
39 |         }
40 |     }
41 | }
42 | 
43 | #[cfg(feature = "ansiterm")]
44 | pub use _impl::*;
45 | 
46 | /// Return true if we should colorize the output, based on [clicolors spec](https://bixense.com/clicolors/) and [no-color spec](https://no-color.org)
47 | ///
48 | /// Note that you should also validate that the output stream is actually connected to a terminal, which usually looks like
49 | /// `atty::is(atty::Stream::Stdout) && should_colorize()
50 | pub fn allowed() -> bool {
51 |     allow_clicolors_spec() && allow_by_no_color_spec()
52 | }
53 | 
54 | fn evar_with_default<'a>(name: &str, default: &'a str) -> Cow<'a, OsStr> {
55 |     std::env::var_os(name)
56 |         .map(Cow::from)
57 |         .unwrap_or_else(|| Cow::Borrowed(OsStr::new(default)))
58 | }
59 | 
60 | fn evar_equals(var: Cow<OsStr>, want: &str) -> bool {
61 |     var == Cow::Borrowed(OsStr::new(want))
62 | }
63 | 
64 | fn evar_not_equals(var: Cow<OsStr>, want: &str) -> bool {
65 |     var != Cow::Borrowed(OsStr::new(want))
66 | }
67 | 
68 | // https://bixense.com/clicolors/
69 | fn allow_clicolors_spec() -> bool {
70 |     evar_equals(evar_with_default("CLICOLOR", "1"), "1")
71 |         || evar_not_equals(evar_with_default("CLICOLOR_FORCE", "0"), "0")
72 | }
73 | 
74 | // https://no-color.org
75 | fn allow_by_no_color_spec() -> bool {
76 |     std::env::var_os("NO_COLOR").is_none()
77 | }
78 | 


--------------------------------------------------------------------------------
/crosstermion/src/cursor.rs:
--------------------------------------------------------------------------------
 1 | mod _impl {
 2 |     pub use crossterm::cursor::MoveUp;
 3 |     pub use crossterm::cursor::{Hide, Show};
 4 | }
 5 | pub use _impl::*;
 6 | 
 7 | #[macro_export]
 8 | macro_rules! execute {
 9 |     ($writer:expr $(, $command:expr)* $(,)? ) => {
10 |         $crate::crossterm::queue!($writer $(, $command)*).and_then(|()| {
11 |             $writer.flush()
12 |         })
13 |     }
14 | }
15 | 


--------------------------------------------------------------------------------
/crosstermion/src/input.rs:
--------------------------------------------------------------------------------
 1 | pub use crossterm::event::{Event, KeyEvent as Key};
 2 | 
 3 | enum Action<T> {
 4 |     Continue,
 5 |     Result(Result<T, std::io::Error>),
 6 | }
 7 | 
 8 | fn continue_on_interrupt<T>(result: Result<T, std::io::Error>) -> Action<T> {
 9 |     match result {
10 |         Ok(v) => Action::Result(Ok(v)),
11 |         Err(err) if err.kind() == std::io::ErrorKind::Interrupted => Action::Continue,
12 |         Err(err) => Action::Result(Err(err)),
13 |     }
14 | }
15 | 
16 | /// Return a receiver of user key input events to avoid blocking the main thread.
17 | pub fn key_input_channel() -> std::sync::mpsc::Receiver<Key> {
18 |     let (key_send, key_receive) = std::sync::mpsc::sync_channel(0);
19 |     std::thread::spawn(move || -> Result<(), std::io::Error> {
20 |         loop {
21 |             let event = match continue_on_interrupt(crossterm::event::read()) {
22 |                 Action::Continue => continue,
23 |                 Action::Result(res) => res?,
24 |             };
25 |             match event {
26 |                 crossterm::event::Event::Key(key) => {
27 |                     if key_send.send(key).is_err() {
28 |                         break;
29 |                     }
30 |                 }
31 |                 _ => continue,
32 |             };
33 |         }
34 |         Ok(())
35 |     });
36 |     key_receive
37 | }
38 | 
39 | /// Return a receiver of user input events to avoid blocking the main thread.
40 | pub fn input_channel() -> std::sync::mpsc::Receiver<Event> {
41 |     use std::convert::TryInto;
42 | 
43 |     let (key_send, key_receive) = std::sync::mpsc::sync_channel(0);
44 |     std::thread::spawn(move || -> Result<(), std::io::Error> {
45 |         loop {
46 |             let event = match continue_on_interrupt(crossterm::event::read()) {
47 |                 Action::Continue => continue,
48 |                 Action::Result(res) => res?,
49 |             };
50 |             if let Ok(event) = event.try_into() {
51 |                 if key_send.send(event).is_err() {
52 |                     break;
53 |                 }
54 |             }
55 |         }
56 |         Ok(())
57 |     });
58 |     key_receive
59 | }
60 | 
61 | /// Return a stream of key input Events
62 | ///
63 | /// Requires the `input-async` feature.
64 | #[cfg(feature = "input-async-crossterm")]
65 | pub fn key_input_stream() -> impl futures_core::stream::Stream<Item = Key> {
66 |     use futures_lite::StreamExt;
67 |     crossterm::event::EventStream::new()
68 |         .filter_map(|r| r.ok())
69 |         .filter_map(|e| match e {
70 |             crossterm::event::Event::Key(key) => Some(key),
71 |             _ => None,
72 |         })
73 | }
74 | 
75 | /// Return a stream of input Events
76 | ///
77 | /// Requires the `input-async` feature.
78 | #[cfg(feature = "input-async-crossterm")]
79 | pub fn input_stream() -> impl futures_core::stream::Stream<Item = Event> {
80 |     use futures_lite::StreamExt;
81 |     crossterm::event::EventStream::new().filter_map(|r| r.ok())
82 | }
83 | 


--------------------------------------------------------------------------------
/crosstermion/src/lib.rs:
--------------------------------------------------------------------------------
 1 | /// Features related to terminal user input
 2 | #[cfg(feature = "crossterm")]
 3 | pub mod input;
 4 | /// Features related to the terminal settings and terminal user interfaces.
 5 | #[cfg(feature = "crossterm")]
 6 | pub mod terminal;
 7 | 
 8 | #[cfg(feature = "crossterm")]
 9 | pub mod cursor;
10 | 
11 | pub mod color;
12 | 
13 | // Reexports
14 | #[cfg(feature = "ansiterm")]
15 | pub use ansiterm as ansi_term;
16 | #[cfg(feature = "crossterm")]
17 | pub use crossterm;
18 | #[cfg(feature = "tui")]
19 | pub use tui;
20 | #[cfg(feature = "tui-react")]
21 | pub use tui_react;
22 | 


--------------------------------------------------------------------------------
/crosstermion/src/terminal.rs:
--------------------------------------------------------------------------------
 1 | #[cfg(feature = "crossterm")]
 2 | mod _impl {
 3 |     use crossterm::{
 4 |         execute,
 5 |         terminal::{self, EnterAlternateScreen, LeaveAlternateScreen},
 6 |     };
 7 |     use std::io;
 8 | 
 9 |     /// Return the horizontal and vertical size of the terminal, if available.
10 |     pub fn size() -> io::Result<(u16, u16)> {
11 |         crossterm::terminal::size()
12 |     }
13 | 
14 |     /// A utility writer to activate an alternate screen in raw mode on instantiation, and resets to previous settings on drop.
15 |     ///
16 |     /// Additionally, it will activate _raw_ mode, which causes user input not to show on screen,
17 |     /// and gets handled byte by byte.
18 |     pub struct AlternateRawScreen<T: io::Write> {
19 |         inner: T,
20 |     }
21 | 
22 |     impl<T: io::Write> AlternateRawScreen<T> {
23 |         pub fn try_from(mut write: T) -> Result<Self, io::Error> {
24 |             terminal::enable_raw_mode()?;
25 |             execute!(write, EnterAlternateScreen)?;
26 |             Ok(AlternateRawScreen { inner: write })
27 |         }
28 |     }
29 | 
30 |     impl<T: io::Write> io::Write for AlternateRawScreen<T> {
31 |         fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
32 |             self.inner.write(buf)
33 |         }
34 | 
35 |         fn flush(&mut self) -> io::Result<()> {
36 |             self.inner.flush()
37 |         }
38 |     }
39 | 
40 |     impl<T: io::Write> Drop for AlternateRawScreen<T> {
41 |         fn drop(&mut self) {
42 |             terminal::disable_raw_mode().ok();
43 |             execute!(self.inner, LeaveAlternateScreen).ok();
44 |         }
45 |     }
46 | 
47 |     #[cfg(all(feature = "tui-crossterm-backend", not(feature = "tui-react")))]
48 |     pub mod tui {
49 |         use tui::backend::CrosstermBackend;
50 | 
51 |         pub fn new_terminal<W: std::io::Write>(
52 |             write: W,
53 |         ) -> Result<tui::Terminal<CrosstermBackend<W>>, std::io::Error> {
54 |             let backend = CrosstermBackend::new(write);
55 |             Ok(tui::Terminal::new(backend)?)
56 |         }
57 |     }
58 | 
59 |     #[cfg(all(feature = "tui-crossterm-backend", feature = "tui-react"))]
60 |     pub mod tui {
61 |         use tui::backend::CrosstermBackend;
62 | 
63 |         pub fn new_terminal<W: std::io::Write>(
64 |             write: W,
65 |         ) -> Result<tui_react::Terminal<CrosstermBackend<W>>, std::io::Error> {
66 |             let backend = CrosstermBackend::new(write);
67 |             Ok(tui_react::Terminal::new(backend)?)
68 |         }
69 |     }
70 | }
71 | pub use _impl::*;
72 | 


--------------------------------------------------------------------------------
/tui-react/.gitignore:
--------------------------------------------------------------------------------
1 | /Cargo.lock
2 | 


--------------------------------------------------------------------------------
/tui-react/CHANGELOG.md:
--------------------------------------------------------------------------------
  1 | # Changelog
  2 | 
  3 | All notable changes to this project will be documented in this file.
  4 | 
  5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
  6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
  7 | 
  8 | ## 0.23.2 (2024-03-10)
  9 | 
 10 | ### Bug Fixes
 11 | 
 12 |  - <csr-id-71c758121751994f129642ae506a6e0c3aefc59a/> fix the fix which had unexpected side-effect.
 13 |    This now mitigates the overflow while also working correctly.
 14 | 
 15 | ### Commit Statistics
 16 | 
 17 | <csr-read-only-do-not-edit/>
 18 | 
 19 |  - 1 commit contributed to the release.
 20 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
 21 |  - 0 issues like '(#ID)' were seen in commit messages
 22 | 
 23 | ### Commit Details
 24 | 
 25 | <csr-read-only-do-not-edit/>
 26 | 
 27 | <details><summary>view details</summary>
 28 | 
 29 |  * **Uncategorized**
 30 |     - Fix the fix which had unexpected side-effect. ([`71c7581`](https://github.com/Byron/tui-crates/commit/71c758121751994f129642ae506a6e0c3aefc59a))
 31 | </details>
 32 | 
 33 | ## 0.23.1 (2024-03-10)
 34 | 
 35 | ### Bug Fixes
 36 | 
 37 |  - <csr-id-6d5e140a59a9f31d9f0c22885b10c85ff6ce845a/> prevent potential overflow during height computation
 38 | 
 39 | ### Commit Statistics
 40 | 
 41 | <csr-read-only-do-not-edit/>
 42 | 
 43 |  - 2 commits contributed to the release.
 44 |  - 35 days passed between releases.
 45 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
 46 |  - 0 issues like '(#ID)' were seen in commit messages
 47 | 
 48 | ### Commit Details
 49 | 
 50 | <csr-read-only-do-not-edit/>
 51 | 
 52 | <details><summary>view details</summary>
 53 | 
 54 |  * **Uncategorized**
 55 |     - Release tui-react v0.23.1 ([`57f7b9e`](https://github.com/Byron/tui-crates/commit/57f7b9e44ae94efceb198a7dc0487fc042d20036))
 56 |     - Prevent potential overflow during height computation ([`6d5e140`](https://github.com/Byron/tui-crates/commit/6d5e140a59a9f31d9f0c22885b10c85ff6ce845a))
 57 | </details>
 58 | 
 59 | ## 0.23.0 (2024-02-03)
 60 | 
 61 | <csr-id-ca29ee1037ed9a153c3d346c231e0562ee948467/>
 62 | 
 63 | ### Chore
 64 | 
 65 |  - <csr-id-ca29ee1037ed9a153c3d346c231e0562ee948467/> update ratatui to 0.26.0
 66 | 
 67 | ### New Features (BREAKING)
 68 | 
 69 |  - <csr-id-943d49d47c04c4ddf36b6ade8652d234d2235961/> update ratatui to 0.26.0
 70 | 
 71 | ### Commit Statistics
 72 | 
 73 | <csr-read-only-do-not-edit/>
 74 | 
 75 |  - 3 commits contributed to the release.
 76 |  - 38 days passed between releases.
 77 |  - 2 commits were understood as [conventional](https://www.conventionalcommits.org).
 78 |  - 0 issues like '(#ID)' were seen in commit messages
 79 | 
 80 | ### Commit Details
 81 | 
 82 | <csr-read-only-do-not-edit/>
 83 | 
 84 | <details><summary>view details</summary>
 85 | 
 86 |  * **Uncategorized**
 87 |     - Release tui-react v0.23.0, safety bump crosstermion v0.14.0 ([`c85ae46`](https://github.com/Byron/tui-crates/commit/c85ae466b18d6a97ddb45a7e2dce632d25ef971b))
 88 |     - Update ratatui to 0.26.0 ([`943d49d`](https://github.com/Byron/tui-crates/commit/943d49d47c04c4ddf36b6ade8652d234d2235961))
 89 |     - Update ratatui to 0.26.0 ([`ca29ee1`](https://github.com/Byron/tui-crates/commit/ca29ee1037ed9a153c3d346c231e0562ee948467))
 90 | </details>
 91 | 
 92 | ## 0.22.0 (2023-12-26)
 93 | 
 94 | ### New Features (BREAKING)
 95 | 
 96 |  - <csr-id-7b49dd81a3f7c209279e90c1110de00dfd6a0701/> upgrade to `ratatui` v0.25
 97 | 
 98 | ### Commit Statistics
 99 | 
100 | <csr-read-only-do-not-edit/>
101 | 
102 |  - 3 commits contributed to the release.
103 |  - 19 days passed between releases.
104 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
105 |  - 0 issues like '(#ID)' were seen in commit messages
106 | 
107 | ### Commit Details
108 | 
109 | <csr-read-only-do-not-edit/>
110 | 
111 | <details><summary>view details</summary>
112 | 
113 |  * **Uncategorized**
114 |     - Release tui-react v0.22.0, safety bump crosstermion v0.13.0 ([`b7283a5`](https://github.com/Byron/tui-crates/commit/b7283a511abadfdbbb6cfbb2832ee1d84c06815c))
115 |     - Merge branch 'remove-termion' ([`c69813f`](https://github.com/Byron/tui-crates/commit/c69813f00e114313b206bceaa838e2fe0954f37b))
116 |     - Upgrade to `ratatui` v0.25 ([`7b49dd8`](https://github.com/Byron/tui-crates/commit/7b49dd81a3f7c209279e90c1110de00dfd6a0701))
117 | </details>
118 | 
119 | ## 0.21.0 (2023-12-07)
120 | 
121 | <csr-id-a371272a96da49e8db82221eaf23d3aab38514d0/>
122 | 
123 | ### Chore (BREAKING)
124 | 
125 |  - <csr-id-a371272a96da49e8db82221eaf23d3aab38514d0/> upgrade `ratatui` to 0.24 and `crossterm` to v0.27.
126 |    Note that these two work together, and depend on each other.
127 | 
128 | ### Commit Statistics
129 | 
130 | <csr-read-only-do-not-edit/>
131 | 
132 |  - 3 commits contributed to the release.
133 |  - 210 days passed between releases.
134 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
135 |  - 0 issues like '(#ID)' were seen in commit messages
136 | 
137 | ### Commit Details
138 | 
139 | <csr-read-only-do-not-edit/>
140 | 
141 | <details><summary>view details</summary>
142 | 
143 |  * **Uncategorized**
144 |     - Release tui-react v0.21.0, crosstermion v0.12.0, safety bump crosstermion v0.12.0 ([`942f0b9`](https://github.com/Byron/tui-crates/commit/942f0b97a4b86b91e26530cca914906645f87ac4))
145 |     - Merge branch 'upgrades' ([`c6265c8`](https://github.com/Byron/tui-crates/commit/c6265c8773829f54e4acb1106d56ef2239edcab7))
146 |     - Upgrade `ratatui` to 0.24 and `crossterm` to v0.27. ([`a371272`](https://github.com/Byron/tui-crates/commit/a371272a96da49e8db82221eaf23d3aab38514d0))
147 | </details>
148 | 
149 | ## 0.20.0 (2023-05-11)
150 | 
151 | <csr-id-073005de8c9177248528a4cc9be58d6cee525394/>
152 | 
153 | ### Chore (BREAKING)
154 | 
155 |  - <csr-id-073005de8c9177248528a4cc9be58d6cee525394/> switch to 'ratatui' in a fashion that leaves imports alone.
156 |    However would still be a breaking change for anyone leaving `tui` in
157 |    their dependency tree.
158 | 
159 | ### Commit Statistics
160 | 
161 | <csr-read-only-do-not-edit/>
162 | 
163 |  - 4 commits contributed to the release.
164 |  - 241 days passed between releases.
165 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
166 |  - 0 issues like '(#ID)' were seen in commit messages
167 | 
168 | ### Commit Details
169 | 
170 | <csr-read-only-do-not-edit/>
171 | 
172 | <details><summary>view details</summary>
173 | 
174 |  * **Uncategorized**
175 |     - Release tui-react v0.20.0, crosstermion v0.11.0, safety bump crosstermion v0.11.0 ([`6cc6346`](https://github.com/Byron/tui-crates/commit/6cc634618e1549fcece860b7b43f5d7ee5d1d259))
176 |     - Merge branch 'ratatui-2' ([`948b539`](https://github.com/Byron/tui-crates/commit/948b5397c0b8317e857f79515165c04314b6838a))
177 |     - Further updates to `crossterm` and `termion` ([`3157b3b`](https://github.com/Byron/tui-crates/commit/3157b3bf392b18f0f6be7e2c04d0b8782d76314e))
178 |     - Switch to 'ratatui' in a fashion that leaves imports alone. ([`073005d`](https://github.com/Byron/tui-crates/commit/073005de8c9177248528a4cc9be58d6cee525394))
179 | </details>
180 | 
181 | ## 0.19.0 (2022-09-12)
182 | 
183 | Upgrade to tui 0.19.
184 | 
185 | ### Commit Statistics
186 | 
187 | <csr-read-only-do-not-edit/>
188 | 
189 |  - 3 commits contributed to the release.
190 |  - 231 days passed between releases.
191 |  - 0 commits were understood as [conventional](https://www.conventionalcommits.org).
192 |  - 0 issues like '(#ID)' were seen in commit messages
193 | 
194 | ### Commit Details
195 | 
196 | <csr-read-only-do-not-edit/>
197 | 
198 | <details><summary>view details</summary>
199 | 
200 |  * **Uncategorized**
201 |     - Release tui-react v0.19.0 ([`6296315`](https://github.com/Byron/tui-crates/commit/629631545c7137c4071df1d895dee6e547e4d149))
202 |     - Prepare changelog prior to release ([`2539f6e`](https://github.com/Byron/tui-crates/commit/2539f6e1a28d038523e342810b94770e57021cd2))
203 |     - Upgrade to tui 19 ([`1b2afad`](https://github.com/Byron/tui-crates/commit/1b2afadba7064febd0d2dffc68f82419f9a4510b))
204 | </details>
205 | 
206 | ## 0.17.0 (2022-01-23)
207 | 
208 | ### New Features (BREAKING)
209 | 
210 |  - <csr-id-b5dd73380c316d1722cc70ec4220d6ea9a7bf141/> upgrade to tui 0.17
211 | 
212 | ### Commit Statistics
213 | 
214 | <csr-read-only-do-not-edit/>
215 | 
216 |  - 3 commits contributed to the release.
217 |  - 171 days passed between releases.
218 |  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
219 |  - 0 issues like '(#ID)' were seen in commit messages
220 | 
221 | ### Commit Details
222 | 
223 | <csr-read-only-do-not-edit/>
224 | 
225 | <details><summary>view details</summary>
226 | 
227 |  * **Uncategorized**
228 |     - Release tui-react v0.17.0 ([`4523678`](https://github.com/Byron/tui-crates/commit/4523678efbc9c876e46325682861c27ee5e7fb02))
229 |     - Add changelog ([`221474b`](https://github.com/Byron/tui-crates/commit/221474b379a2c3c2f0c45dff5471659413bb9548))
230 |     - Upgrade to tui 0.17 ([`b5dd733`](https://github.com/Byron/tui-crates/commit/b5dd73380c316d1722cc70ec4220d6ea9a7bf141))
231 | </details>
232 | 
233 | ## v0.16.0 (2021-08-04)
234 | 
235 | ### Commit Statistics
236 | 
237 | <csr-read-only-do-not-edit/>
238 | 
239 |  - 3 commits contributed to the release over the course of 93 calendar days.
240 |  - 0 commits were understood as [conventional](https://www.conventionalcommits.org).
241 |  - 0 issues like '(#ID)' were seen in commit messages
242 | 
243 | ### Commit Details
244 | 
245 | <csr-read-only-do-not-edit/>
246 | 
247 | <details><summary>view details</summary>
248 | 
249 |  * **Uncategorized**
250 |     - Upgrade to tui 0.16 ([`907a5e5`](https://github.com/Byron/tui-crates/commit/907a5e591688732c3f88821daebc7ff8c010730b))
251 |     - Changes repository paths in tui crates manifests ([`ac5c6e6`](https://github.com/Byron/tui-crates/commit/ac5c6e62c86189a72e2305d06da176821f88b180))
252 |     - Add tui crates ([`ccb6a24`](https://github.com/Byron/tui-crates/commit/ccb6a24315a7d881e50b24e98d4720406bff16d5))
253 | </details>
254 | 
255 | 


--------------------------------------------------------------------------------
/tui-react/Cargo.toml:
--------------------------------------------------------------------------------
 1 | [package]
 2 | name = "tui-react"
 3 | version = "0.23.2"
 4 | authors = ["Sebastian Thiel <sthiel@thoughtworks.com>"]
 5 | edition = "2018"
 6 | repository = "https://github.com/Byron/tui-crates"
 7 | description = "TUI widgets using a react-like paradigm, allowing mutable component state and render properties."
 8 | readme = "README.md"
 9 | license = "MIT"
10 | 
11 | [dependencies]
12 | tui = { package = "ratatui", version = "0.26.0", default-features = false }
13 | log = "0.4.6"
14 | unicode-segmentation = "1.6.0"
15 | unicode-width = "0.1.7"
16 | 


--------------------------------------------------------------------------------
/tui-react/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 Sebastian Thiel
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/tui-react/README.md:
--------------------------------------------------------------------------------
 1 | **tui-react** is a library to enable components with state, and with properties provided per render
 2 | 
 3 | Please note that this crate is early in development and built for the needs of **dua**.
 4 | 
 5 | ### How it works
 6 | 
 7 | It uses the TUI infrastructure Terminal, but alters it to not enforce implementing the `Widget` trait. 
 8 | It provides only a single, optional, trait called `TopLevelComponent`, which makes it convenient to
 9 | draw its implementers with `Terminal::render(..)`. However, since this enforces the absence of
10 | references in your state, it's probably not suitable for most.
11 | 
12 | Instead, any struct can implement `render` methods or functions, and freely write into the terminal.
13 | That way, one can leverage everything Rust has to offer, which allows stateful components which
14 | work in your favor. Thus, this crate does away with 'one size fits all' render implementations,
15 | greatly adding to flexibility.
16 | 
17 | State that one wants within the component for instance could be the scroll location. Alternatively,
18 | one can configure windows by altering their public state.
19 | 
20 | ### What's the relation to TUI / Ratatui?
21 | 
22 | This project couldn't exist without TUI, and is happy to provide an alternative set of components
23 | for use in command-line applications. Ratatui is the continuation of the tui project.
24 | 
25 | ### Why `tui-react`?
26 | 
27 | I kept having a terrible feeling when managing state with tui widgets when writing **dua**, and
28 | after trying many things, I realized what the problem actually was. It took me some time to
29 | realize it's not possible to have stateful components in with TUI, and I admire the smarts
30 | that went into the API design! After all, it effectively prohibited this! Amazing!
31 | 
32 | That's why I implemented my own terminal and some key components, based on the ones provided
33 | by TUI, which can serve as standard building blocks in a stateful world.
34 | 
35 | Thus far, the experience was fantastic, and it feels much better than before. Let's see what
36 | happens with it.
37 | 
38 | ### Changelog
39 | 
40 | #### v0.4.1 - Simplify `block_width(…)` function
41 | 
42 | #### v0.2.1 - add license file to crate
43 | 


--------------------------------------------------------------------------------
/tui-react/src/lib.rs:
--------------------------------------------------------------------------------
  1 | #![forbid(unsafe_code)]
  2 | 
  3 | mod list;
  4 | mod terminal;
  5 | 
  6 | pub use list::*;
  7 | pub use terminal::*;
  8 | 
  9 | use std::iter::repeat;
 10 | use tui::{self, buffer::Buffer, layout::Rect, style::Color, style::Style};
 11 | use unicode_segmentation::UnicodeSegmentation;
 12 | use unicode_width::UnicodeWidthStr;
 13 | 
 14 | pub fn fill_background_to_right(mut s: String, entire_width: u16) -> String {
 15 |     match (s.len(), entire_width as usize) {
 16 |         (x, y) if x >= y => s,
 17 |         (x, y) => {
 18 |             s.extend(repeat(' ').take(y - x));
 19 |             s
 20 |         }
 21 |     }
 22 | }
 23 | 
 24 | /// Helper method to quickly set the background of all cells inside the specified area.
 25 | pub fn fill_background(area: Rect, buf: &mut Buffer, color: Color) {
 26 |     for y in area.top()..area.bottom() {
 27 |         for x in area.left()..area.right() {
 28 |             buf.get_mut(x, y).set_bg(color);
 29 |         }
 30 |     }
 31 | }
 32 | 
 33 | pub fn draw_text_with_ellipsis_nowrap(
 34 |     bound: Rect,
 35 |     buf: &mut Buffer,
 36 |     text: impl AsRef<str>,
 37 |     style: impl Into<Option<Style>>,
 38 | ) -> u16 {
 39 |     let s = style.into();
 40 |     let t = text.as_ref();
 41 |     let mut graphemes = t.graphemes(true);
 42 |     let mut total_width = 0;
 43 |     {
 44 |         let mut ellipsis_candidate_x = None;
 45 |         let mut x_offset = 0;
 46 |         for (g, mut x) in graphemes.by_ref().zip(bound.left()..bound.right()) {
 47 |             let width = g.width();
 48 |             total_width += width;
 49 | 
 50 |             x += x_offset;
 51 |             let cell = buf.get_mut(x, bound.y);
 52 |             if x + 1 == bound.right() {
 53 |                 ellipsis_candidate_x = Some(x);
 54 |             }
 55 |             cell.set_symbol(g.into());
 56 |             if let Some(s) = s {
 57 |                 cell.set_style(s);
 58 |             }
 59 | 
 60 |             x_offset += width.saturating_sub(1) as u16;
 61 |             if x + x_offset >= bound.right() {
 62 |                 break;
 63 |             }
 64 |             let x = x as usize;
 65 |             for x in x + 1..x + width {
 66 |                 let i = buf.index_of(x as u16, bound.y);
 67 |                 buf.content[i].reset();
 68 |             }
 69 |         }
 70 |         if let (Some(_), Some(x)) = (graphemes.next(), ellipsis_candidate_x) {
 71 |             buf.get_mut(x, bound.y).set_symbol("…".into());
 72 |         }
 73 |     }
 74 |     total_width as u16
 75 | }
 76 | 
 77 | pub fn draw_text_nowrap_fn(
 78 |     bound: Rect,
 79 |     buf: &mut Buffer,
 80 |     t: impl AsRef<str>,
 81 |     mut s: impl FnMut(&str, u16, u16) -> Style,
 82 | ) {
 83 |     if bound.width == 0 {
 84 |         return;
 85 |     }
 86 |     for (g, x) in t.as_ref().graphemes(true).zip(bound.left()..bound.right()) {
 87 |         let cell = buf.get_mut(x, bound.y);
 88 |         cell.set_symbol(g.into());
 89 |         cell.set_style(s(cell.symbol(), x, bound.y));
 90 |     }
 91 | }
 92 | 
 93 | pub mod util {
 94 |     use unicode_segmentation::UnicodeSegmentation;
 95 |     use unicode_width::UnicodeWidthStr;
 96 | 
 97 |     pub fn sanitize_offset(offset: u16, num_items: usize, num_displayable_lines: u16) -> u16 {
 98 |         offset.min((num_items.saturating_sub(num_displayable_lines as usize)) as u16)
 99 |     }
100 | 
101 |     #[derive(Default)]
102 |     pub struct GraphemeCountWriter(pub usize);
103 | 
104 |     impl std::io::Write for GraphemeCountWriter {
105 |         fn write(&mut self, buf: &[u8]) -> Result<usize, std::io::Error> {
106 |             self.0 += String::from_utf8_lossy(buf).graphemes(true).count();
107 |             Ok(buf.len())
108 |         }
109 | 
110 |         fn flush(&mut self) -> Result<(), std::io::Error> {
111 |             Ok(())
112 |         }
113 |     }
114 | 
115 |     pub fn block_width(s: &str) -> u16 {
116 |         s.width() as u16
117 |     }
118 | 
119 |     pub mod rect {
120 |         use tui::layout::Rect;
121 | 
122 |         /// A safe version of Rect::intersection that doesn't suffer from underflows
123 |         pub fn intersect(lhs: Rect, rhs: Rect) -> Rect {
124 |             let x1 = lhs.x.max(rhs.x);
125 |             let y1 = lhs.y.max(rhs.y);
126 |             let x2 = lhs.right().min(rhs.right());
127 |             let y2 = lhs.bottom().min(rhs.bottom());
128 |             Rect {
129 |                 x: x1,
130 |                 y: y1,
131 |                 width: x2.saturating_sub(x1),
132 |                 height: y2.saturating_sub(y1),
133 |             }
134 |         }
135 | 
136 |         pub fn offset_x(r: Rect, offset: u16) -> Rect {
137 |             Rect {
138 |                 x: r.x + offset,
139 |                 width: r.width.saturating_sub(offset),
140 |                 ..r
141 |             }
142 |         }
143 | 
144 |         pub fn snap_to_right(bound: Rect, new_width: u16) -> Rect {
145 |             offset_x(bound, bound.width.saturating_sub(new_width))
146 |         }
147 | 
148 |         pub fn line_bound(bound: Rect, line: usize) -> Rect {
149 |             Rect {
150 |                 y: bound.y + line as u16,
151 |                 height: 1,
152 |                 ..bound
153 |             }
154 |         }
155 |     }
156 | }
157 | 


--------------------------------------------------------------------------------
/tui-react/src/list.rs:
--------------------------------------------------------------------------------
 1 | use tui::{
 2 |     buffer::Buffer,
 3 |     layout::Rect,
 4 |     text::{Line, Span, Text},
 5 |     widgets::{Block, Paragraph, Widget},
 6 | };
 7 | 
 8 | #[derive(Default)]
 9 | pub struct List {
10 |     /// The index at which the list last started. Used for scrolling
11 |     pub offset: usize,
12 | }
13 | 
14 | impl List {
15 |     fn list_offset_for(&self, entry_in_view: Option<usize>, height: usize) -> usize {
16 |         match entry_in_view {
17 |             Some(pos) => match height as usize {
18 |                 h if (self.offset + h).saturating_sub(1) < pos => pos - h + 1,
19 |                 _ if self.offset > pos => pos,
20 |                 _ => self.offset,
21 |             },
22 |             None => 0,
23 |         }
24 |     }
25 | }
26 | 
27 | #[derive(Default)]
28 | pub struct ListProps<'b> {
29 |     pub block: Option<Block<'b>>,
30 |     pub entry_in_view: Option<usize>,
31 | }
32 | 
33 | impl List {
34 |     pub fn render<'a, 't>(
35 |         &mut self,
36 |         props: ListProps<'a>,
37 |         items: impl IntoIterator<Item = Vec<Span<'t>>>,
38 |         area: Rect,
39 |         buf: &mut Buffer,
40 |     ) {
41 |         let ListProps {
42 |             block,
43 |             entry_in_view,
44 |         } = props;
45 | 
46 |         let list_area = match block {
47 |             Some(b) => {
48 |                 let inner_area = b.inner(area);
49 |                 b.render(area, buf);
50 |                 inner_area
51 |             }
52 |             None => area,
53 |         };
54 |         self.offset = self.list_offset_for(entry_in_view, list_area.height as usize);
55 | 
56 |         if list_area.width < 1 || list_area.height < 1 {
57 |             return;
58 |         }
59 | 
60 |         for (i, vec_of_spans) in items
61 |             .into_iter()
62 |             .skip(self.offset)
63 |             .enumerate()
64 |             .take(list_area.height as usize)
65 |         {
66 |             let (x, y) = (list_area.left(), list_area.top() + i as u16);
67 |             Paragraph::new(Text::from(Line::from(vec_of_spans))).render(
68 |                 Rect {
69 |                     x,
70 |                     y,
71 |                     width: list_area.width,
72 |                     height: 1,
73 |                 },
74 |                 buf,
75 |             );
76 |         }
77 |     }
78 | }
79 | 


--------------------------------------------------------------------------------
/tui-react/src/terminal.rs:
--------------------------------------------------------------------------------
  1 | //! Derived from TUI-rs, license: MIT, Copyright (c) 2016 Florian Dehau
  2 | use log::error;
  3 | use std::{borrow::Borrow, io};
  4 | 
  5 | use tui::{backend::Backend, buffer::Buffer, layout::Rect};
  6 | 
  7 | /// A component meant to be rendered by `Terminal::render(...)`.
  8 | /// All other components don't have to implement this trait, and instead
  9 | /// provide a render method by convention, tuned towards their needs using whichever
 10 | /// generic types or lifetimes they need.
 11 | pub trait ToplevelComponent {
 12 |     type Props;
 13 | 
 14 |     fn render(&mut self, props: impl Borrow<Self::Props>, area: Rect, buf: &mut Buffer);
 15 | }
 16 | 
 17 | #[derive(Debug)]
 18 | pub struct Terminal<B>
 19 | where
 20 |     B: Backend,
 21 | {
 22 |     pub backend: B,
 23 |     buffers: [Buffer; 2],
 24 |     current: usize,
 25 |     hidden_cursor: bool,
 26 |     known_size: Rect,
 27 | }
 28 | 
 29 | impl<B> Drop for Terminal<B>
 30 | where
 31 |     B: Backend,
 32 | {
 33 |     fn drop(&mut self) {
 34 |         // Attempt to restore the cursor state
 35 |         if self.hidden_cursor {
 36 |             if let Err(err) = self.show_cursor() {
 37 |                 error!("Failed to show the cursor: {}", err);
 38 |             }
 39 |         }
 40 |     }
 41 | }
 42 | 
 43 | impl<B> Terminal<B>
 44 | where
 45 |     B: Backend,
 46 | {
 47 |     pub fn new(backend: B) -> io::Result<Terminal<B>> {
 48 |         let size = backend.size()?;
 49 |         Ok(Terminal {
 50 |             backend,
 51 |             buffers: [Buffer::empty(size), Buffer::empty(size)],
 52 |             current: 0,
 53 |             hidden_cursor: false,
 54 |             known_size: size,
 55 |         })
 56 |     }
 57 | 
 58 |     pub fn current_buffer_mut(&mut self) -> &mut Buffer {
 59 |         &mut self.buffers[self.current]
 60 |     }
 61 | 
 62 |     pub fn reconcile_and_flush(&mut self) -> io::Result<()> {
 63 |         let previous_buffer = &self.buffers[1 - self.current];
 64 |         let current_buffer = &self.buffers[self.current];
 65 |         let updates = previous_buffer.diff(current_buffer);
 66 |         self.backend.draw(updates.into_iter())
 67 |     }
 68 | 
 69 |     pub fn resize(&mut self, area: Rect) -> io::Result<()> {
 70 |         self.buffers[self.current].resize(area);
 71 |         self.buffers[1 - self.current].reset();
 72 |         self.buffers[1 - self.current].resize(area);
 73 |         self.known_size = area;
 74 |         self.backend.clear()
 75 |     }
 76 | 
 77 |     pub fn autoresize(&mut self) -> io::Result<()> {
 78 |         let size = self.size()?;
 79 |         if self.known_size != size {
 80 |             self.resize(size)?;
 81 |         }
 82 |         Ok(())
 83 |     }
 84 | 
 85 |     /// Get ready for rendering and return the maximum display size as `Rect`
 86 |     pub fn pre_render(&mut self) -> io::Result<Rect> {
 87 |         // Autoresize - otherwise we get glitches if shrinking or potential desync between widgets
 88 |         // and the terminal (if growing), which may OOB.
 89 |         self.autoresize()?;
 90 |         Ok(self.known_size)
 91 |     }
 92 | 
 93 |     pub fn post_render(&mut self) -> io::Result<()> {
 94 |         self.reconcile_and_flush()?;
 95 | 
 96 |         self.buffers[1 - self.current].reset();
 97 |         self.current = 1 - self.current;
 98 | 
 99 |         self.backend.flush()?;
100 |         Ok(())
101 |     }
102 | 
103 |     pub fn render<C>(&mut self, component: &mut C, props: impl Borrow<C::Props>) -> io::Result<()>
104 |     where
105 |         C: ToplevelComponent,
106 |     {
107 |         self.pre_render()?;
108 |         component.render(props, self.known_size, self.current_buffer_mut());
109 |         self.post_render()
110 |     }
111 | 
112 |     pub fn hide_cursor(&mut self) -> io::Result<()> {
113 |         self.backend.hide_cursor()?;
114 |         self.hidden_cursor = true;
115 |         Ok(())
116 |     }
117 |     pub fn show_cursor(&mut self) -> io::Result<()> {
118 |         self.backend.show_cursor()?;
119 |         self.hidden_cursor = false;
120 |         Ok(())
121 |     }
122 |     pub fn get_cursor(&mut self) -> io::Result<(u16, u16)> {
123 |         self.backend.get_cursor()
124 |     }
125 |     pub fn set_cursor(&mut self, x: u16, y: u16) -> io::Result<()> {
126 |         self.backend.set_cursor(x, y)
127 |     }
128 |     pub fn clear(&mut self) -> io::Result<()> {
129 |         self.backend.clear()
130 |     }
131 |     pub fn size(&self) -> io::Result<Rect> {
132 |         self.backend.size()
133 |     }
134 | }
135 | 
136 | #[cfg(test)]
137 | mod tests {
138 |     use super::*;
139 |     use tui::backend::TestBackend;
140 | 
141 |     #[derive(Default, Clone)]
142 |     struct ComplexProps {
143 |         x: usize,
144 |         y: String,
145 |     }
146 | 
147 |     #[derive(Default)]
148 |     struct StatefulComponent {
149 |         x: usize,
150 |     }
151 | 
152 |     #[derive(Default)]
153 |     struct StatelessComponent;
154 | 
155 |     impl ToplevelComponent for StatefulComponent {
156 |         type Props = usize;
157 | 
158 |         fn render(&mut self, props: impl Borrow<Self::Props>, _area: Rect, _buf: &mut Buffer) {
159 |             self.x += *props.borrow();
160 |         }
161 |     }
162 | 
163 |     impl ToplevelComponent for StatelessComponent {
164 |         type Props = ComplexProps;
165 |         fn render(&mut self, _props: impl Borrow<Self::Props>, _area: Rect, _buf: &mut Buffer) {
166 |             // does not matter - we want to see it compiles essentially
167 |         }
168 |     }
169 | 
170 |     #[test]
171 |     fn it_does_render_with_simple_and_complex_props() {
172 |         let mut term = Terminal::new(TestBackend::new(20, 20)).unwrap();
173 |         let mut c = StatefulComponent::default();
174 | 
175 |         term.render(&mut c, 3usize).ok();
176 |         assert_eq!(c.x, 3);
177 | 
178 |         let mut c = StatelessComponent::default();
179 |         term.render(&mut c, ComplexProps::default()).ok();
180 |     }
181 | }
182 | 


--------------------------------------------------------------------------------