docs(examples): refactor demo2 #836
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joshka
requested review from
orhun,
mindoodoo,
sayanarijit,
kdheepak and
Valentin271
as code owners
|
Includes #833 |
joshka
force-pushed
the
refactor-demo2
branch
from
7ad8482
to
3ac6d52
Compare
joshka
changed the title
|
Changed this to the |
joshka
added a commit
that referenced
this pull request
Jan 20, 2024
Many widgets can be rendered without changing their state.
This commit implements The `Widget` trait for various references to
widgets and changes their implementations to be immutable.
This allows us to render widgets without consuming them by passing a ref
to the widget when calling `Frame::render_widget()`.
```rust
// this might be stored in a struct
let paragraph = Paragraph::new("Hello world!");
let [left, right] = area.split(&Layout::horizontal([20, 20]));
frame.render_widget(¶graph, left);
frame.render_widget(¶graph, right); // we can reuse the widget
```
- Clear
- Block
- Tabs
- Sparkline
- Paragraph
- Gauge
- Calendar
Other widgets will be implemented in follow up commits.
Fixes: #164
Replaces PRs: #122 and
#16
Enables: #132
Validated as a viable working solution by: #836
joshka
force-pushed
the
refactor-demo2
branch
2 times, most recently
from
09c2846
to
d750b02
Compare
Valentin271
approved these changes
Jan 24, 2024
joshka
added a commit
that referenced
this pull request
Jan 24, 2024
Many widgets can be rendered without changing their state.
This commit implements The `Widget` trait for various references to
widgets and changes their implementations to be immutable.
This allows us to render widgets without consuming them by passing a ref
to the widget when calling `Frame::render_widget()`.
```rust
// this might be stored in a struct
let paragraph = Paragraph::new("Hello world!");
let [left, right] = area.split(&Layout::horizontal([20, 20]));
frame.render_widget(¶graph, left);
frame.render_widget(¶graph, right); // we can reuse the widget
```
- Clear
- Block
- Tabs
- Sparkline
- Paragraph
- Gauge
- Calendar
Other widgets will be implemented in follow up commits.
Fixes: #164
Replaces PRs: #122 and
#16
Enables: #132
Validated as a viable working solution by: #836
joshka
added a commit
that referenced
this pull request
Jan 24, 2024
Many widgets can be rendered without changing their state.
This commit implements The `Widget` trait for references to
widgets and changes their implementations to be immutable.
This allows us to render widgets without consuming them by passing a ref
to the widget when calling `Frame::render_widget()`.
```rust
// this might be stored in a struct
let paragraph = Paragraph::new("Hello world!");
let [left, right] = area.split(&Layout::horizontal([20, 20]));
frame.render_widget(¶graph, left);
frame.render_widget(¶graph, right); // we can reuse the widget
```
Implemented for all widgets except BarChart (which has an implementation
that modifies the internal state and requires a rewrite to fix.
Other widgets will be implemented in follow up commits.
Fixes: #164
Replaces PRs: #122 and
#16
Enables: #132
Validated as a viable working solution by:
#836
Simplified a bunch of the logic in the demo2 example - Moved destroy mode to its own file. - Moved error handling to its own file. - Removed AppContext - Implemented Widget for &App. The app state is small enough that it doesn't matter here and we could just copy or clone the app state on every frame, but for larger apps this can be a significant performance improvement. - Made the tabs stateful - Made the term module just a collection of functions rather than a struct. - Changed to use color_eyre for error handling. - Changed keyboard shortcuts and rearranged the bottom bar. - Use strum for the tabs enum.
joshka
force-pushed
the
refactor-demo2
branch
from
d750b02
to
077492a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #836 +/- ##
=====================================
Coverage 92.3% 92.3%
=====================================
Files 61 61
Lines 16141 16096 -45
=====================================
- Hits 14903 14872 -31
+ Misses 1238 1224 -14 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Simplified a bunch of the logic in the demo2 example
doesn't matter here and we could just copy or clone the app state on
every frame, but for larger apps this can be a significant performance
improvement.
struct.