NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
crates.io, #1193 most downloaded on crates.io
A library that's all about cooking up terminal user interfaces
Latest stable
0.30.2
Last release 5 months ago
19 Jun 2026
Release timing varies
gaps range from 2 weeks to 5 months
Nearly every release is documented
notes for 18 of 19 stable releases
Nothing withdrawn
no release was ever pulled
4 years old
87 releases · first in 2023
Drag across the ruler to compare, or tap a release to open it.
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
26af650 (text) Add push methods for text and line (#998)
Adds the following methods to the `Text` and `Line` structs:
- Text::push_line
- Text::push_span
- Line::push_span
This allows for adding lines and spans to a text object without having
to call methods on the fields directly, which is usefult for incremental
construction of text objects.
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
0207160 (line) Line truncation respects alignment (#987)
When rendering a `Line`, the line will be truncated:
- on the right for left aligned lines
- on the left for right aligned lines
- on bot sides for centered lines
E.g. "Hello World" will be rendered as "Hello", "World", "lo wo" for
left, right, centered lines respectively.
Fixes:https://github.com/ratatui-org/ratatui/issues/932
c56f49b (list) Saturating_sub to fix highlight_symbol overflow (#949)
An overflow (pedantically an underflow) can occur if the
highlight_symbol is a multi-byte char, and area is reduced to a size
less than that char length.
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
742a5ea (text) Fix panic when rendering out of bounds (#997)
Previously it was possible to cause a panic when rendering to an area
outside of the buffer bounds. Instead this now correctly renders nothing
to the buffer.
f6c4e44 (uncategorized) Ensure that paragraph correctly renders styled text (#992)
Paragraph was ignoring the new `Text::style` field added in 0.26.0
Fixes:https://github.com/ratatui-org/ratatui/issues/990
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8719608 (span) Rename to_aligned_line into into_aligned_line (#993)
With the Rust method naming conventions these methods are into methods
consuming the Span. Therefore, it's more consistent to use `into_`
instead of `to_`.
```rust
Span::to_centered_line
Span::to_left_aligned_line
Span::to_right_aligned_line
```
Are marked deprecated and replaced with the following
```rust
Span::into_centered_line
Span::into_left_aligned_line
Span::into_right_aligned_line
```
359204c (uncategorized) Simplify to io::Result (#1016)
Simplifies the code, logic stays exactly the same.
8e68db9 (uncategorized) Remove pointless default on internal structs (#980)
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
125ee92 (docs) Fix: fix typos in crate documentation (#1002)
07da90a (funding) Add eth address for receiving funds from drips.network (#994)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
26af650 (text) Add push methods for text and line (#998)
Adds the following methods to the `Text` and `Line` structs:
- Text::push_line
- Text::push_span
- Line::push_span
This allows for adding lines and spans to a text object without having
to call methods on the fields directly, which is usefult for incremental
construction of text objects.
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
0207160 (line) Line truncation respects alignment (#987)
When rendering a `Line`, the line will be truncated:
- on the right for left aligned lines
- on the left for right aligned lines
- on bot sides for centered lines
E.g. "Hello World" will be rendered as "Hello", "World", "lo wo" for
left, right, centered lines respectively.
Fixes:https://github.com/ratatui-org/ratatui/issues/932
c56f49b (list) Saturating_sub to fix highlight_symbol overflow (#949)
An overflow (pedantically an underflow) can occur if the
highlight_symbol is a multi-byte char, and area is reduced to a size
less than that char length.
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
742a5ea (text) Fix panic when rendering out of bounds (#997)
Previously it was possible to cause a panic when rendering to an area
outside of the buffer bounds. Instead this now correctly renders nothing
to the buffer.
f6c4e44 (uncategorized) Ensure that paragraph correctly renders styled text (#992)
Paragraph was ignoring the new `Text::style` field added in 0.26.0
Fixes:https://github.com/ratatui-org/ratatui/issues/990
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8719608 (span) Rename to_aligned_line into into_aligned_line (#993)
With the Rust method naming conventions these methods are into methods
consuming the Span. Therefore, it's more consistent to use `into_`
instead of `to_`.
```rust
Span::to_centered_line
Span::to_left_aligned_line
Span::to_right_aligned_line
```
Are marked deprecated and replaced with the following
```rust
Span::into_centered_line
Span::into_left_aligned_line
Span::into_right_aligned_line
```
359204c (uncategorized) Simplify to io::Result (#1016)
Simplifies the code, logic stays exactly the same.
8e68db9 (uncategorized) Remove pointless default on internal structs (#980)
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
125ee92 (docs) Fix: fix typos in crate documentation (#1002)
07da90a (funding) Add eth address for receiving funds from drips.network (#994)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
26af650 (text) Add push methods for text and line (#998)
Adds the following methods to the `Text` and `Line` structs:
- Text::push_line
- Text::push_span
- Line::push_span
This allows for adding lines and spans to a text object without having
to call methods on the fields directly, which is usefult for incremental
construction of text objects.
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
c56f49b (list) Saturating_sub to fix highlight_symbol overflow (#949)
An overflow (pedantically an underflow) can occur if the
highlight_symbol is a multi-byte char, and area is reduced to a size
less than that char length.
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
742a5ea (text) Fix panic when rendering out of bounds (#997)
Previously it was possible to cause a panic when rendering to an area
outside of the buffer bounds. Instead this now correctly renders nothing
to the buffer.
f6c4e44 (uncategorized) Ensure that paragraph correctly renders styled text (#992)
Paragraph was ignoring the new `Text::style` field added in 0.26.0
Fixes:https://github.com/ratatui-org/ratatui/issues/990
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8719608 (span) Rename to_aligned_line into into_aligned_line (#993)
With the Rust method naming conventions these methods are into methods
consuming the Span. Therefore, it's more consistent to use `into_`
instead of `to_`.
```rust
Span::to_centered_line
Span::to_left_aligned_line
Span::to_right_aligned_line
```
Are marked deprecated and replaced with the following
```rust
Span::into_centered_line
Span::into_left_aligned_line
Span::into_right_aligned_line
```
8e68db9 (uncategorized) Remove pointless default on internal structs (#980)
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
125ee92 (docs) Fix: fix typos in crate documentation (#1002)
07da90a (funding) Add eth address for receiving funds from drips.network (#994)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
c56f49b (list) Saturating_sub to fix highlight_symbol overflow (#949)
An overflow (pedantically an underflow) can occur if the
highlight_symbol is a multi-byte char, and area is reduced to a size
less than that char length.
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
f6c4e44 (uncategorized) Ensure that paragraph correctly renders styled text (#992)
Paragraph was ignoring the new `Text::style` field added in 0.26.0
Fixes:https://github.com/ratatui-org/ratatui/issues/990
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8719608 (span) Rename to_aligned_line into into_aligned_line (#993)
With the Rust method naming conventions these methods are into methods
consuming the Span. Therefore, it's more consistent to use `into_`
instead of `to_`.
```rust
Span::to_centered_line
Span::to_left_aligned_line
Span::to_right_aligned_line
```
Are marked deprecated and replaced with the following
```rust
Span::into_centered_line
Span::into_left_aligned_line
Span::into_right_aligned_line
```
8e68db9 (uncategorized) Remove pointless default on internal structs (#980)
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8e68db9 (uncategorized) Remove pointless default on internal structs (#980)
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
Therefore, this is not containing anything that can be a breaking change.
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
c12bcfe (non-src) Apply pedantic lints (#976)
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benchs, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const (#974)
enabled by default on nightly
fdb14dc (uncategorized) Clippy::redundant_type_annotations (#974)
9b3b23a (uncategorized) Remove literal suffix (#974)
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect (#974)
c870a41 (uncategorized) Clippy::many_single_char_names (#974)
fcbea9e (uncategorized) Clippy::uninlined_format_args (#974)
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls (#974)
0de5238 (uncategorized) Dead_code (#974)
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports (#974)
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec (#974)
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes (#974)
660c718 (uncategorized) Clippy::empty_line_after_doc_comments (#974)
ab951fa (uncategorized) Clippy::return_self_not_must_use (#974)
9bc014d (uncategorized) Clippy::items_after_statements (#974)
8536760 (uncategorized) Clippy::inefficient_to_string (#974)
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned (#974)
e02f476 (borders) Allow border!() in const (#977)
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline (#979)
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value (#974)
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref (#974)
a13867f (uncategorized) Clippy::cloned_instead_of_copied (#974)
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
c4ce7e8 (uncategorized) Enable more satisfied lints (#974)
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 (#974) [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
<!-- generated by git-cliff -->
2cfe82a *(buffer)* Deprecate assert_buffer_eq! in favor of assert_eq! by @EdJoPaTo in #1007
<img src="https://github.com/ratatui-org.png" >
We are happy to announce a brand new Ratatui Forum 🐭 for Rust & TUI enthusiasts.
This is a patch release that fixes the unicode truncation bug, adds performance and quality of life improvements.
✨ Release highlights: https://ratatui.rs/highlights/v0263/
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046 **
The caller put in the wrong x/y -> the caller is the cause.
bf09234 (table) Make TableState::new const by @EdJoPaTo in #1040
eb281df (uncategorized) Use inner Display implementation by @EdJoPaTo in #1097
ec763af (uncategorized) Make Stylize's .bg(color) generic by @kdheepak in #1099
This PR makes `.bg(color)` generic accepting anything that can be
converted into `Color`; similar to the `.fg(color)` method on the same
trait
4d1784f (uncategorized) Re-export ParseColorError as style::ParseColorError by @joshka in #1086
Fixes:https://github.com/ratatui-org/ratatui/issues/1085
366cbae (buffer) Fix Debug panic and fix formatting of overridden parts by @EdJoPaTo in #1098
Fix panic in `Debug for Buffer` when `width == 0`.
Also corrects the output when symbols are overridden.
4392759 (examples) Changed user_input example to work with multi-byte unicode chars by @OkieOth in #1069
This is the proposed solution for issue #1068. It solves the bug in the
user_input example with multi-byte UTF-8 characters as input.
Fixes:#1068
20fc0dd (examples) Fix key handling in constraints by @psobolik in #1066
Add check for `KeyEventKind::Press` to constraints example's event
handler to eliminate double keys
on Windows.
Fixes:#1062
f4637d4 (reflow) Allow wrapping at zero width whitespace by @kxxt in #1074
699c2d7 (uncategorized) Unicode truncation bug by @joshka in #1089
- Rewrote the line / span rendering code to take into account how
multi-byte / wide emoji characters are truncated when rendering into
areas that cannot accommodate them in the available space
- Added comprehensive coverage over the edge cases
- Adds a benchmark to ensure perf
Fixes:https://github.com/ratatui-org/ratatui/issues/1032
b30411d (uncategorized) Termwiz underline color test by @joshka in #1094
Fixes code that doesn't compile in the termwiz tests when
underline-color feature is enabled.
5f1e119 (uncategorized) Correct feature flag typo for termwiz by @joshka in #1088
underline-color was incorrectly spelt as underline_color
0a16496 (uncategorized) Use to_string to serialize Color by @SleepySwords in #934
Since deserialize now uses `FromStr` to deserialize color, serializing
`Color` RGB values, as well as index values, would produce an output
that would no longer be able to be deserialized without causing an
error.
Color::Rgb will now be serialized as the hex representation of their
value.
For example, with serde_json, Color::Rgb(255, 0, 255) would be
serialized as "#FF00FF" rather than {"Rgb": [255, 0, 255]}.
Color::Indexed will now be serialized as just the string of the index.
For example, with serde_json, Color::Indexed(10) would be serialized
as "10" rather than {"Indexed": 10}.
Other color variants remain the same.
2cfe82a (buffer) Deprecate assert_buffer_eq! in favor of assert_eq! by @EdJoPaTo in #1007
- Simplify `assert_buffer_eq!` logic.
- Deprecate `assert_buffer_eq!`.
- Introduce `TestBackend::assert_buffer_lines`.
Also simplify many tests involving buffer comparisons.
For the deprecation, just use `assert_eq` instead of `assert_buffer_eq`:
```diff
-assert_buffer_eq!(actual, expected);
+assert_eq!(actual, expected);
```
---
I noticed `assert_buffer_eq!` creating no test coverage reports and
looked into this macro. First I simplified it. Then I noticed a bunch of
`assert_eq!(buffer, …)` and other indirect usages of this macro (like
`TestBackend::assert_buffer`).
The good thing here is that it's mainly used in tests so not many
changes to the library code.
baedc39 (buffer) Simplify set_stringn logic by @EdJoPaTo in #1083
9bd89c2 (clippy) Enable breaking lint checks by @EdJoPaTo in #988
We need to make sure to not change existing methods without a notice.
But at the same time this also finds public additions with mistakes
before they are even released which is what I would like to have.
This renames a method and deprecated the old name hinting to a new name.
Should this be mentioned somewhere, so it's added to the release notes?
It's not breaking because the old method is still there.
bef5bcf (example) Remove pointless new method by @EdJoPaTo in #1038
Use `App::default()` directly.
da1ade7 (github) Update code owners about past maintainers by @orhun in #1073
As per suggestion in
https://github.com/ratatui-org/ratatui/pull/1067#issuecomment-2079766990
It's good for historical purposes!
3687f78 (github) Update code owners by @orhun in #1067
Removes the team members that are not able to review PRs recently (with
their approval ofc)
839cca2 (table) Fix typo in docs for highlight_symbol by @kdheepak in #1108
f945a0b (test) Fix typo in TestBackend documentation by @orhun in #1107
828d17a (uncategorized) Add minimal example by @joshka in #1114
e95230b (uncategorized) Add note about scrollbar state content length by @Utagai in #1077
366c2a0 (block) Use Block::bordered by @EdJoPaTo in #1041
Block::bordered() is shorter than
Block::new().borders(Borders::ALL), requires one less import
(Borders) and in case Block::default() was used before can even be
const.
2e71c18 (buffer) Simplify Buffer::filled with macro by @EdJoPaTo in #1036
The `vec![]` macro is highly optimized by the Rust team and shorter.
Don't do it manually.
This change is mainly cleaner code. The only production code that uses
this is `Terminal::with_options` and `Terminal::insert_before` so it's
not performance relevant on every render.
81b9633 (calendar) Use const fn by @EdJoPaTo in #1039
Also, do the comparison without `as u8`. Stays the same at runtime and
is cleaner code.
c442dfd (canvas) Change map data to const instead of static by @EdJoPaTo in #1037
1706b0a (crossterm) Speed up combined fg and bg color changes by up to 20% by @joshka in #1072
1a4bb1c (layout) Avoid allocating memory when using split ergonomic utils by @tranzystorekk in #1105
Don't create intermediate vec in `Layout::areas` and
`Layout::spacers` when there's no need for one.
aa4260f (uncategorized) Use std::fmt instead of importing Debug and Display by @joshka in #1087
This is a small universal style change to avoid making this change a
part of other PRs.
[rationale](https://github.com/ratatui-org/ratatui/pull/1083#discussion_r1588466060)
5fbb77a (readme) Use terminal theme for badges by @TadoTheMiner in #1026
The badges in the readme were all the default theme. Giving them
prettier colors that match the terminal gif is better. I've used the
colors from the VHS repo.
bef2bc1 (cargo) Add homepage to Cargo.toml by @joshka in #1080
76e5fe5 (uncategorized) Revert "Make Stylize's .bg(color) generic" by @kdheepak in #1102
This reverts commit ec763af8512df731799c8f30c38c37252068a4c4 from #1099
64eb391 (uncategorized) Fixup cargo lint for windows targets by @joshka in #1071
Crossterm brings in multiple versions of the same dep
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
4955380 (uncategorized) Remove pre-push hooks by @joshka in #1115
28e81c0 (uncategorized) Add underline-color to all features flag in makefile by @joshka in #1100
c75aa19 (uncategorized) Add clippy::cargo lint by @joshka in #1053
Followup to https://github.com/ratatui-org/ratatui/pull/1035 and
https://github.com/ratatui-org/ratatui/discussions/1034
It's reasonable to enable this and deal with breakage by fixing any
specific issues that arise.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3
2cfe82a *(buffer)* Deprecate assert_buffer_eq! in favor of assert_eq! by @EdJoPaTo in #1007
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046
The caller put in the wrong x/y -> the caller is the cause.
bf09234 (table) Make TableState::new const by @EdJoPaTo in #1040
eb281df (uncategorized) Use inner Display implementation by @EdJoPaTo in #1097
ec763af (uncategorized) Make Stylize's .bg(color) generic by @kdheepak in #1099
This PR makes `.bg(color)` generic accepting anything that can be
converted into `Color`; similar to the `.fg(color)` method on the same
trait
4d1784f (uncategorized) Re-export ParseColorError as style::ParseColorError by @joshka in #1086
Fixes:https://github.com/ratatui-org/ratatui/issues/1085
366cbae (buffer) Fix Debug panic and fix formatting of overridden parts by @EdJoPaTo in #1098
Fix panic in `Debug for Buffer` when `width == 0`.
Also corrects the output when symbols are overridden.
4392759 (examples) Changed user_input example to work with multi-byte unicode chars by @OkieOth in #1069
This is the proposed solution for issue #1068. It solves the bug in the
user_input example with multi-byte UTF-8 characters as input.
Fixes:#1068
20fc0dd (examples) Fix key handling in constraints by @psobolik in #1066
Add check for `KeyEventKind::Press` to constraints example's event
handler to eliminate double keys
on Windows.
Fixes:#1062
f4637d4 (reflow) Allow wrapping at zero width whitespace by @kxxt in #1074
699c2d7 (uncategorized) Unicode truncation bug by @joshka in #1089
- Rewrote the line / span rendering code to take into account how
multi-byte / wide emoji characters are truncated when rendering into
areas that cannot accommodate them in the available space
- Added comprehensive coverage over the edge cases
- Adds a benchmark to ensure perf
Fixes:https://github.com/ratatui-org/ratatui/issues/1032
b30411d (uncategorized) Termwiz underline color test by @joshka in #1094
Fixes code that doesn't compile in the termwiz tests when
underline-color feature is enabled.
5f1e119 (uncategorized) Correct feature flag typo for termwiz by @joshka in #1088
underline-color was incorrectly spelt as underline_color
0a16496 (uncategorized) Use to_string to serialize Color by @SleepySwords in #934
Since deserialize now uses `FromStr` to deserialize color, serializing
`Color` RGB values, as well as index values, would produce an output
that would no longer be able to be deserialized without causing an
error.
Color::Rgb will now be serialized as the hex representation of their
value.
For example, with serde_json, Color::Rgb(255, 0, 255) would be
serialized as "#FF00FF" rather than {"Rgb": [255, 0, 255]}.
Color::Indexed will now be serialized as just the string of the index.
For example, with serde_json, Color::Indexed(10) would be serialized
as "10" rather than {"Indexed": 10}.
Other color variants remain the same.
2cfe82a (buffer) Deprecate assert_buffer_eq! in favor of assert_eq! by @EdJoPaTo in #1007
- Simplify `assert_buffer_eq!` logic.
- Deprecate `assert_buffer_eq!`.
- Introduce `TestBackend::assert_buffer_lines`.
Also simplify many tests involving buffer comparisons.
For the deprecation, just use `assert_eq` instead of `assert_buffer_eq`:
```diff
-assert_buffer_eq!(actual, expected);
+assert_eq!(actual, expected);
```
---
I noticed `assert_buffer_eq!` creating no test coverage reports and
looked into this macro. First I simplified it. Then I noticed a bunch of
`assert_eq!(buffer, …)` and other indirect usages of this macro (like
`TestBackend::assert_buffer`).
The good thing here is that it's mainly used in tests so not many
changes to the library code.
baedc39 (buffer) Simplify set_stringn logic by @EdJoPaTo in #1083
9bd89c2 (clippy) Enable breaking lint checks by @EdJoPaTo in #988
We need to make sure to not change existing methods without a notice.
But at the same time this also finds public additions with mistakes
before they are even released which is what I would like to have.
This renames a method and deprecated the old name hinting to a new name.
Should this be mentioned somewhere, so it's added to the release notes?
It's not breaking because the old method is still there.
bef5bcf (example) Remove pointless new method by @EdJoPaTo in #1038
Use `App::default()` directly.
da1ade7 (github) Update code owners about past maintainers by @orhun in #1073
As per suggestion in
https://github.com/ratatui-org/ratatui/pull/1067#issuecomment-2079766990
It's good for historical purposes!
3687f78 (github) Update code owners by @orhun in #1067
Removes the team members that are not able to review PRs recently (with
their approval ofc)
839cca2 (table) Fix typo in docs for highlight_symbol by @kdheepak in #1108
f945a0b (test) Fix typo in TestBackend documentation by @orhun in #1107
e95230b (uncategorized) Add note about scrollbar state content length by @Utagai in #1077
366c2a0 (block) Use Block::bordered by @EdJoPaTo in #1041
Block::bordered() is shorter than
Block::new().borders(Borders::ALL), requires one less import
(Borders) and in case Block::default() was used before can even be
const.
2e71c18 (buffer) Simplify Buffer::filled with macro by @EdJoPaTo in #1036
The `vec![]` macro is highly optimized by the Rust team and shorter.
Don't do it manually.
This change is mainly cleaner code. The only production code that uses
this is `Terminal::with_options` and `Terminal::insert_before` so it's
not performance relevant on every render.
81b9633 (calendar) Use const fn by @EdJoPaTo in #1039
Also, do the comparison without `as u8`. Stays the same at runtime and
is cleaner code.
c442dfd (canvas) Change map data to const instead of static by @EdJoPaTo in #1037
1706b0a (crossterm) Speed up combined fg and bg color changes by up to 20% by @joshka in #1072
1a4bb1c (layout) Avoid allocating memory when using split ergonomic utils by @tranzystorekk in #1105
Don't create intermediate vec in `Layout::areas` and
`Layout::spacers` when there's no need for one.
aa4260f (uncategorized) Use std::fmt instead of importing Debug and Display by @joshka in #1087
This is a small universal style change to avoid making this change a
part of other PRs.
[rationale](https://github.com/ratatui-org/ratatui/pull/1083#discussion_r1588466060)
5fbb77a (readme) Use terminal theme for badges by @TadoTheMiner in #1026
The badges in the readme were all the default theme. Giving them
prettier colors that match the terminal gif is better. I've used the
colors from the VHS repo.
bef2bc1 (cargo) Add homepage to Cargo.toml by @joshka in #1080
76e5fe5 (uncategorized) Revert "Make Stylize's .bg(color) generic" by @kdheepak in #1102
This reverts commit ec763af8512df731799c8f30c38c37252068a4c4 from #1099
64eb391 (uncategorized) Fixup cargo lint for windows targets by @joshka in #1071
Crossterm brings in multiple versions of the same dep
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
28e81c0 (uncategorized) Add underline-color to all features flag in makefile by @joshka in #1100
c75aa19 (uncategorized) Add clippy::cargo lint by @joshka in #1053
Followup to https://github.com/ratatui-org/ratatui/pull/1035 and
https://github.com/ratatui-org/ratatui/discussions/1034
It's reasonable to enable this and deal with breakage by fixing any
specific issues that arise.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3-alpha.4
<!-- generated by git-cliff -->
97ee102 *(buffer)* Track_caller for index_of by @EdJoPaTo in #1046
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046
The caller put in the wrong x/y -> the caller is the cause.
bf09234 (table) Make TableState::new const by @EdJoPaTo in #1040
4d1784f (uncategorized) Re-export ParseColorError as style::ParseColorError by @joshka in #1086
Fixes:https://github.com/ratatui-org/ratatui/issues/1085
4392759 (examples) Changed user_input example to work with multi-byte unicode chars by @OkieOth in #1069
This is the proposed solution for issue #1068. It solves the bug in the
user_input example with multi-byte UTF-8 characters as input.
Fixes:#1068
20fc0dd (examples) Fix key handling in constraints by @psobolik in #1066
Add check for `KeyEventKind::Press` to constraints example's event
handler to eliminate double keys
on Windows.
Fixes:#1062
f4637d4 (reflow) Allow wrapping at zero width whitespace by @kxxt in #1074
5f1e119 (uncategorized) Correct feature flag typo for termwiz by @joshka in #1088
underline-color was incorrectly spelt as underline_color
0a16496
(uncategorized) Use to_string to serialize Color by @SleepySwords in #934
Since deserialize now uses `FromStr` to deserialize color, serializing
`Color` RGB values, as well as index values, would produce an output
that would no longer be able to be deserialized without causing an
error.
Color::Rgb will now be serialized as the hex representation of their
value.
For example, with serde_json, Color::Rgb(255, 0, 255) would be
serialized as "#FF00FF" rather than {"Rgb": [255, 0, 255]}.
Color::Indexed will now be serialized as just the string of the index.
For example, with serde_json, Color::Indexed(10) would be serialized
as "10" rather than {"Indexed": 10}.
Other color variants remain the same.
baedc39 (buffer) Simplify set_stringn logic by @EdJoPaTo in #1083
bef5bcf (example) Remove pointless new method by @EdJoPaTo in #1038
Use `App::default()` directly.
da1ade7 (github) Update code owners about past maintainers by @orhun in #1073
As per suggestion in
https://github.com/ratatui-org/ratatui/pull/1067#issuecomment-2079766990
It's good for historical purposes!
3687f78 (github) Update code owners by @orhun in #1067
Removes the team members that are not able to review PRs recently (with
their approval ofc)
e95230b (uncategorized) Add note about scrollbar state content length by @Utagai in #1077
366c2a0 (block) Use Block::bordered by @EdJoPaTo in #1041
Block::bordered() is shorter than
Block::new().borders(Borders::ALL), requires one less import
(Borders) and in case Block::default() was used before can even be
const.
2e71c18 (buffer) Simplify Buffer::filled with macro by @EdJoPaTo in #1036
The `vec![]` macro is highly optimized by the Rust team and shorter.
Don't do it manually.
This change is mainly cleaner code. The only production code that uses
this is `Terminal::with_options` and `Terminal::insert_before` so it's
not performance relevant on every render.
81b9633 (calendar) Use const fn by @EdJoPaTo in #1039
Also, do the comparison without `as u8`. Stays the same at runtime and
is cleaner code.
c442dfd (canvas) Change map data to const instead of static by @EdJoPaTo in #1037
1706b0a (crossterm) Speed up combined fg and bg color changes by up to 20% by @joshka in #1072
aa4260f (uncategorized) Use std::fmt instead of importing Debug and Display by @joshka in #1087
This is a small universal style change to avoid making this change a
part of other PRs.
[rationale](https://github.com/ratatui-org/ratatui/pull/1083#discussion_r1588466060)
5fbb77a (readme) Use terminal theme for badges by @TadoTheMiner in #1026
The badges in the readme were all the default theme. Giving them
prettier colors that match the terminal gif is better. I've used the
colors from the VHS repo.
bef2bc1 (cargo) Add homepage to Cargo.toml by @joshka in #1080
64eb391 (uncategorized) Fixup cargo lint for windows targets by @joshka in #1071
Crossterm brings in multiple versions of the same dep
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
c75aa19 (uncategorized) Add clippy::cargo lint by @joshka in #1053
Followup to https://github.com/ratatui-org/ratatui/pull/1035 and
https://github.com/ratatui-org/ratatui/discussions/1034
It's reasonable to enable this and deal with breakage by fixing any
specific issues that arise.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3-alpha.3
<!-- generated by git-cliff -->
97ee102 *(buffer)* Track_caller for index_of by @EdJoPaTo in #1046
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046
The caller put in the wrong x/y -> the caller is the cause.
bf09234 (table) Make TableState::new const by @EdJoPaTo in #1040
4392759 (examples) Changed user_input example to work with multi-byte unicode chars by @OkieOth in #1069
This is the proposed solution for issue #1068. It solves the bug in the
user_input example with multi-byte UTF-8 characters as input.
Fixes:#1068
20fc0dd (examples) Fix key handling in constraints by @psobolik in #1066
Add check for `KeyEventKind::Press` to constraints example's event
handler to eliminate double keys
on Windows.
Fixes:#1062
f4637d4 (reflow) Allow wrapping at zero width whitespace by @kxxt in #1074
0a16496
(uncategorized) Use to_string to serialize Color by @SleepySwords in #934
Since deserialize now uses `FromStr` to deserialize color, serializing
`Color` RGB values, as well as index values, would produce an output
that would no longer be able to be deserialized without causing an
error.
Color::Rgb will now be serialized as the hex representation of their
value.
For example, with serde_json, Color::Rgb(255, 0, 255) would be
serialized as "#FF00FF" rather than {"Rgb": [255, 0, 255]}.
Color::Indexed will now be serialized as just the string of the index.
For example, with serde_json, Color::Indexed(10) would be serialized
as "10" rather than {"Indexed": 10}.
Other color variants remain the same.
baedc39 (buffer) Simplify set_stringn logic by @EdJoPaTo in #1083
bef5bcf (example) Remove pointless new method by @EdJoPaTo in #1038
Use `App::default()` directly.
da1ade7 (github) Update code owners about past maintainers by @orhun in #1073
As per suggestion in
https://github.com/ratatui-org/ratatui/pull/1067#issuecomment-2079766990
It's good for historical purposes!
3687f78 (github) Update code owners by @orhun in #1067
Removes the team members that are not able to review PRs recently (with
their approval ofc)
e95230b (uncategorized) Add note about scrollbar state content length by @Utagai in #1077
366c2a0 (block) Use Block::bordered by @EdJoPaTo in #1041
Block::bordered() is shorter than
Block::new().borders(Borders::ALL), requires one less import
(Borders) and in case Block::default() was used before can even be
const.
2e71c18 (buffer) Simplify Buffer::filled with macro by @EdJoPaTo in #1036
The `vec![]` macro is highly optimized by the Rust team and shorter.
Don't do it manually.
This change is mainly cleaner code. The only production code that uses
this is `Terminal::with_options` and `Terminal::insert_before` so it's
not performance relevant on every render.
81b9633 (calendar) Use const fn by @EdJoPaTo in #1039
Also, do the comparison without `as u8`. Stays the same at runtime and
is cleaner code.
c442dfd (canvas) Change map data to const instead of static by @EdJoPaTo in #1037
1706b0a (crossterm) Speed up combined fg and bg color changes by up to 20% by @joshka in #1072
5fbb77a (readme) Use terminal theme for badges by @TadoTheMiner in #1026
The badges in the readme were all the default theme. Giving them
prettier colors that match the terminal gif is better. I've used the
colors from the VHS repo.
bef2bc1 (cargo) Add homepage to Cargo.toml by @joshka in #1080
64eb391 (uncategorized) Fixup cargo lint for windows targets by @joshka in #1071
Crossterm brings in multiple versions of the same dep
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
c75aa19 (uncategorized) Add clippy::cargo lint by @joshka in #1053
Followup to https://github.com/ratatui-org/ratatui/pull/1035 and
https://github.com/ratatui-org/ratatui/discussions/1034
It's reasonable to enable this and deal with breakage by fixing any
specific issues that arise.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3-alpha.2
<!-- generated by git-cliff -->
97ee102 *(buffer)* Track_caller for index_of by @EdJoPaTo in #1046
97ee102 (buffer) Track_caller for index_of by @EdJoPaTo in #1046
The caller put in the wrong x/y -> the caller is the cause.
bf09234 (table) Make TableState::new const by @EdJoPaTo in #1040
0a16496
(uncategorized) Use to_string to serialize Color by @SleepySwords in #934
Since deserialize now uses `FromStr` to deserialize color, serializing
`Color` RGB values, as well as index values, would produce an output
that would no longer be able to be deserialized without causing an
error.
Color::Rgb will now be serialized as the hex representation of their
value.
For example, with serde_json, Color::Rgb(255, 0, 255) would be
serialized as "#FF00FF" rather than {"Rgb": [255, 0, 255]}.
Color::Indexed will now be serialized as just the string of the index.
For example, with serde_json, Color::Indexed(10) would be serialized
as "10" rather than {"Indexed": 10}.
Other color variants remain the same.
2e71c18 (buffer) Simplify Buffer::filled with macro by @EdJoPaTo in #1036
The `vec![]` macro is highly optimized by the Rust team and shorter.
Don't do it manually.
This change is mainly cleaner code. The only production code that uses
this is `Terminal::with_options` and `Terminal::insert_before` so it's
not performance relevant on every render.
81b9633 (calendar) Use const fn by @EdJoPaTo in #1039
Also, do the comparison without `as u8`. Stays the same at runtime and
is cleaner code.
c442dfd (canvas) Change map data to const instead of static by @EdJoPaTo in #1037
5fbb77a (readme) Use terminal theme for badges by @TadoTheMiner in #1026
The badges in the readme were all the default theme. Giving them
prettier colors that match the terminal gif is better. I've used the
colors from the VHS repo.
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
c75aa19 (uncategorized) Add clippy::cargo lint by @joshka in #1053
Followup to https://github.com/ratatui-org/ratatui/pull/1035 and
https://github.com/ratatui-org/ratatui/discussions/1034
It's reasonable to enable this and deal with breakage by fixing any
specific issues that arise.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3-alpha.1
<!-- generated by git-cliff -->
bef5bcf *(example)* Remove pointless new method by @EdJoPaTo in #1038
326a461 (uncategorized) Add package categories field by @mcskware in #1035
Add the package categories field in Cargo.toml, with value
`["command-line-interface"]`. This fixes the (currently non-default)
clippy cargo group lint
[`clippy::cargo_common_metadata`](https://rust-lang.github.io/rust-clippy/master/index.html#/cargo_common_metadata).
As per discussion in [Cargo package categories
suggestions](https://github.com/ratatui-org/ratatui/discussions/1034),
this lint is not suggested to be run by default in CI, but rather as an
occasional one-off as part of the larger
[`clippy::cargo`](https://doc.rust-lang.org/stable/clippy/lints.html#cargo)
lint group.
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.2...v0.26.3-alpha.0
<!-- generated by git-cliff -->
Therefore, this is not containing anything that can be a breaking change.
<img src="https://github.com/ratatui-org.png" >
This is a patch release that fixes bugs and adds enhancements, including new iterator constructors, List scroll padding, and various rendering improvements. ✨
✨ Release highlights: https://ratatui.rs/highlights/v0262/
11b452d (layout) Mark various functions as const by @EdJoPaTo in #951
1cff511 (line) Impl Styled for Line by @joshka in #968
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists by @CameronBarnes in #958
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
26af650 (text) Add push methods for text and line by @joshka in #998
Adds the following methods to the `Text` and `Line` structs:
- Text::push_line
- Text::push_span
- Line::push_span
This allows for adding lines and spans to a text object without having
to call methods on the fields directly, which is useful for incremental
construction of text objects.
b5bdde0
(text) Add FromIterator impls for Line and Text by @joshka in #967
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String by @kdheepak in #952
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
0207160 (line) Line truncation respects alignment by @TadoTheMiner in #987
When rendering a `Line`, the line will be truncated:
- on the right for left aligned lines
- on the left for right aligned lines
- on bot sides for centered lines
E.g. "Hello World" will be rendered as "Hello", "World", "lo wo" for
left, right, centered lines respectively.
Fixes:https://github.com/ratatui-org/ratatui/issues/932
c56f49b (list) Saturating_sub to fix highlight_symbol overflow by @mrjackwills in #949
An overflow (pedantically an underflow) can occur if the
highlight_symbol is a multi-byte char, and area is reduced to a size
less than that char length.
943c043 (scrollbar) Dont render on 0 length track by @EdJoPaTo in #964
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
742a5ea (text) Fix panic when rendering out of bounds by @joshka in #997
Previously it was possible to cause a panic when rendering to an area
outside of the buffer bounds. Instead this now correctly renders nothing
to the buffer.
f6c4e44 (uncategorized) Ensure that paragraph correctly renders styled text by @joshka in #992
Paragraph was ignoring the new `Text::style` field added in 0.26.0
Fixes:https://github.com/ratatui-org/ratatui/issues/990
35e971f (uncategorized) Scrollbar thumb not visible on long lists by @ThomasMiz in #959
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
6fd5f63 (lint) Prefer idiomatic for loops by @EdJoPaTo
37b957c (lints) Add lints to scrollbar by @EdJoPaTo
c12bcfe (non-src) Apply pedantic lints by @EdJoPaTo in #976
Fixes many not yet enabled lints (mostly pedantic) on everything that is
not the lib (examples, benches, tests). Therefore, this is not containing
anything that can be a breaking change.
Lints are not enabled as that should be the job of #974. I created this
as a separate PR as its mostly independent and would only clutter up the
diff of #974 even more.
Also see
https://github.com/ratatui-org/ratatui/pull/974#discussion_r1506458743
---------
8719608 (span) Rename to_aligned_line into into_aligned_line by @EdJoPaTo in #993
With the Rust method naming conventions these methods are into methods
consuming the Span. Therefore, it's more consistent to use `into_`
instead of `to_`.
```rust
Span::to_centered_line
Span::to_left_aligned_line
Span::to_right_aligned_line
```
Are marked deprecated and replaced with the following
```rust
Span::into_centered_line
Span::into_left_aligned_line
Span::into_right_aligned_line
```
b831c56 (widget-ref) Clippy::needless_pass_by_value by @EdJoPaTo
359204c (uncategorized) Simplify to io::Result by @EdJoPaTo in #1016
Simplifies the code, logic stays exactly the same.
8e68db9 (uncategorized) Remove pointless default on internal structs by @EdJoPaTo in #980
See #978
Also remove other derives. They are unused and just slow down compilation.
3be189e (uncategorized) Clippy::thread_local_initializer_can_be_made_const by @EdJoPaTo
enabled by default on nightly
5c4efac (uncategorized) Clippy::map_err_ignore by @EdJoPaTo
bbb6d65 (uncategorized) Clippy::else_if_without_else by @EdJoPaTo
fdb14dc (uncategorized) Clippy::redundant_type_annotations by @EdJoPaTo
9b3b23a (uncategorized) Remove literal suffix by @EdJoPaTo
its not needed and can just be assumed
related:clippy::(un)separated_literal_suffix
58b6e0b (uncategorized) Clippy::should_panic_without_expect by @EdJoPaTo
c870a41 (uncategorized) Clippy::many_single_char_names by @EdJoPaTo
a6036ad (uncategorized) Clippy::similar_names by @EdJoPaTo
060d26b (uncategorized) Clippy::match_same_arms by @EdJoPaTo
fcbea9e (uncategorized) Clippy::uninlined_format_args by @EdJoPaTo
14b24e7 (uncategorized) Clippy::if_not_else by @EdJoPaTo
5ed1f43 (uncategorized) Clippy::redundant_closure_for_method_calls by @EdJoPaTo
c8c7924 (uncategorized) Clippy::too_many_lines by @EdJoPaTo
e3afe7c (uncategorized) Clippy::unreadable_literal by @EdJoPaTo
a1f54de (uncategorized) Clippy::bool_to_int_with_if by @EdJoPaTo
b8ea190 (uncategorized) Clippy::cast_lossless by @EdJoPaTo
0de5238 (uncategorized) Dead_code by @EdJoPaTo
enabled by default, only detected by nightly yet
df5dddf (uncategorized) Unused_imports by @EdJoPaTo
enabled by default, only detected on nightly yet
f1398ae (uncategorized) Clippy::useless_vec by @EdJoPaTo
Lint enabled by default but only nightly finds this yet
525848f (uncategorized) Manually apply clippy::use_self for impl with lifetimes by @EdJoPaTo
660c718 (uncategorized) Clippy::empty_line_after_doc_comments by @EdJoPaTo
ab951fa (uncategorized) Clippy::return_self_not_must_use by @EdJoPaTo
3cd4369 (uncategorized) Clippy::doc_markdown by @EdJoPaTo
9bc014d (uncategorized) Clippy::items_after_statements by @EdJoPaTo
36a0cd5 (uncategorized) Clippy::deref_by_slicing by @EdJoPaTo
f7f6692 (uncategorized) Clippy::equatable_if_let by @EdJoPaTo
01418eb (uncategorized) Clippy::default_trait_access by @EdJoPaTo
8536760 (uncategorized) Clippy::inefficient_to_string by @EdJoPaTo
a558b19 (uncategorized) Clippy::implicit_clone by @EdJoPaTo
5b00e3a (uncategorized) Clippy::use_self by @EdJoPaTo
27680c0 (uncategorized) Clippy::semicolon_if_nothing_returned by @EdJoPaTo
14461c3 (breaking-changes) Typos and markdownlint by @EdJoPaTo in #1009
3b002fd (uncategorized) Update incompatible code warning in examples readme by @joshka in #1013
e02f476 (borders) Allow border!() in const by @EdJoPaTo in #977
This allows more compiler optimizations when the macro is used.
541f0f9 (cell) Use const CompactString::new_inline by @EdJoPaTo in #979
Some minor find when messing around trying to `const` all the things.
While `reset()` and `default()` can not be `const` it's still a benefit
when their contents are.
65e7923 (scrollbar) Const creation by @EdJoPaTo in #963
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
8195f52 (uncategorized) Clippy::needless_pass_by_value by @EdJoPaTo
183c07e (uncategorized) Clippy::trivially_copy_pass_by_ref by @EdJoPaTo
a13867f (uncategorized) Clippy::cloned_instead_of_copied by @EdJoPaTo
3834374 (uncategorized) Clippy::missing_const_for_fn by @EdJoPaTo
125ee92 (docs) Fix: fix typos in crate documentation by @orhun in #1002
38c17e0 (editorconfig) Set and apply some defaults by @EdJoPaTo
07da90a (funding) Add eth address for receiving funds from drips.network by @BenJam in #994
078e97e (github) Add EdJoPaTo as a maintainer by @orhun in #986
b0314c5 (uncategorized) Remove conventional commit check for PR by @Valentin271 in #950
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
6e6ba27 (lint) Warn on pedantic and allow the rest by @EdJoPaTo
c4ce7e8 (uncategorized) Enable more satisfied lints by @EdJoPaTo
These lints dont generate warnings and therefore dont need refactoring.
I think they are useful in the future.
a4e84a6 (uncategorized) Increase msrv to 1.74.0 by @EdJoPaTo [breaking]
configure lints in Cargo.toml requires 1.74.0
BREAKING CHANGE:rust 1.74 is required now
Full Changelog: https://github.com/ratatui-org/ratatui/compare/v0.26.1...v0.26.2
11b452d *(layout)* Mark various functions as const
1cff511 (line) Impl Styled for Line (#968)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
654949b (list) Add Scroll Padding to Lists (#958)
Introduces scroll padding, which allows the api user to request that a certain number of ListItems be kept visible above and below the currently selected item while scrolling.
```rust
let list = List::new(items).scroll_padding(1);
```
Fixes:https://github.com/ratatui-org/ratatui/pull/955
b5bdde0
(text) Add FromIterator impls for Line and Text (#967)
This adds `FromIterator` impls for `Line` and `Text` that allow creating
`Line` and `Text` instances from iterators of `Span` and `Line`
instances, respectively.
```rust
let line = Line::from_iter(vec!["Hello".blue(), " world!".green()]);
let line: Line = iter::once("Hello".blue())
.chain(iter::once(" world!".green()))
.collect();
let text = Text::from_iter(vec!["The first line", "The second line"]);
let text: Text = iter::once("The first line")
.chain(iter::once("The second line"))
.collect();
```
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
943c043 (scrollbar) Dont render on 0 length track (#964)
Fixes a panic when `track_length - 1` is used. (clamp panics on `-1.0`
being smaller than `0.0`)
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
65e7923 (scrollbar) Const creation (#963)
A bunch of `const fn` allow for more performance and `Default` now uses the `const` new implementations.
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
<!-- generated by git-cliff -->
11b452d *(layout)* Mark various functions as const
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
35e971f (uncategorized) Scrollbar thumb not visible on long lists (#959)
When displaying somewhat-long lists, the `Scrollbar` widget sometimes did not display a thumb character, and only the track will be visible.
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
<!-- generated by git-cliff -->
11b452d *(layout)* Mark various functions as const
12f67e8
(uncategorized) Impl Widget for &str and String (#952)
Currently, `f.render_widget("hello world".bold(), area)` works but
`f.render_widget("hello world", area)` doesn't. This PR changes that my
implementing `Widget` for `&str` and `String`. This makes it easier to
render strings with no styles as widgets.
Example usage:
```rust
terminal.draw(|f| f.render_widget("Hello World!", f.size()))?;
```
---------
b0314c5 (uncategorized) Remove conventional commit check for PR (#950)
This removes conventional commit check for PRs.
Since we use the PR title and description this is useless. It fails a
lot of time and we ignore it.
IMPORTANT NOTE: This does **not** mean Ratatui abandons conventional
commits. This only relates to commits in PRs.
<!-- generated by git-cliff -->
This is a patch release that fixes bugs and adds enhancements, including new iterators, title options for blocks, and various rendering improvements.
<img src="https://github.com/ratatui-org.png" >
This is a patch release that fixes bugs and adds enhancements, including new iterators, title options for blocks, and various rendering improvements. ✨
74a0511 (rect) Add Rect::positions iterator (#928)
Useful for performing some action on all the cells in a particular area.
E.g.,
```rust
fn render(area: Rect, buf: &mut Buffer) {
for position in area.positions() {
buf.get_mut(position.x, position.y).set_symbol("x");
}
}
```
9182f47 (uncategorized) Add Block::title_top and Block::title_top_bottom (#940)
This adds the ability to add titles to the top and bottom of a block
without having to use the `Title` struct (which will be removed in a
future release - likely v0.28.0).
Fixes a subtle bug if the title was created from a right aligned Line
and was also right aligned. The title would be rendered one cell too far
to the right.
```rust
Block::bordered()
.title_top(Line::raw("A").left_aligned())
.title_top(Line::raw("B").centered())
.title_top(Line::raw("C").right_aligned())
.title_bottom(Line::raw("D").left_aligned())
.title_bottom(Line::raw("E").centered())
.title_bottom(Line::raw("F").right_aligned())
.render(buffer.area, &mut buffer);
// renders
"┌A─────B─────C┐",
"│ │",
"└D─────E─────F┘",
```
Addresses part of https://github.com/ratatui-org/ratatui/issues/738
2202059 (block) Fix crash on empty right aligned title (#933)
- Simplified implementation of the rendering for block.
- Introduces a subtle rendering change where centered titles that are
odd in length will now be rendered one character to the left compared
to before. This aligns with other places that we render centered text
and is a more consistent behavior. See
https://github.com/ratatui-org/ratatui/pull/807#discussion_r1455645954
for another example of this.
Fixes: https://github.com/ratatui-org/ratatui/pull/929
14c67fb (list) Highlight symbol when using a multi-bytes char (#924)
ratatui v0.26.0 brought a regression in the List widget, in which the
highlight symbol width was incorrectly calculated - specifically when
the highlight symbol was a multi-char character, e.g. `▶`.
0dcdbea (paragraph) Render Line::styled correctly inside a paragraph (#930)
Renders the styled graphemes of the line instead of the contained spans.
fae5862 (uncategorized) Ensure that buffer::set_line sets the line style (#926)
Fixes a regression in 0.26 where buffer::set_line was no longer setting
the style. This was due to the new style field on Line instead of being
stored only in the spans.
Also adds a configuration for just running unit tests to bacon.toml.
fbb5dfa (uncategorized) Scrollbar rendering when no track symbols are provided (#911)
61a8278 (canvas) Add documentation to canvas module (#913)
Document the whole `canvas` module. With this, the whole `widgets`
module is documented.
18870ce (uncategorized) Fix the method name for setting the Line style (#947)
8fb4630 (uncategorized) Remove github action bot that makes comments nudging commit signing (#937)
We can consider reverting this commit once this PR is merged:
https://github.com/1Password/check-signed-commits-action/pull/9
Thank you so much to everyone that contributed to this release!
Here is the list of contributors who have contributed to ratatui for the first time!
74a0511 *(rect)* Add Rect::positions iterator
74a0511 (rect) Add Rect::positions iterator (#928)
Useful for performing some action on all the cells in a particular area.
E.g.,
```rust
fn render(area: Rect, buf: &mut Buffer) {
for position in area.positions() {
buf.get_mut(position.x, position.y).set_symbol("x");
}
}
```
9182f47 (uncategorized) Add Block::title_top and Block::title_top_bottom (#940)
This adds the ability to add titles to the top and bottom of a block
without having to use the `Title` struct (which will be removed in a
future release - likely v0.28.0).
Fixes a subtle bug if the title was created from a right aligned Line
and was also right aligned. The title would be rendered one cell too far
to the right.
```rust
Block::bordered()
.title_top(Line::raw("A").left_aligned())
.title_top(Line::raw("B").centered())
.title_top(Line::raw("C").right_aligned())
.title_bottom(Line::raw("D").left_aligned())
.title_bottom(Line::raw("E").centered())
.title_bottom(Line::raw("F").right_aligned())
.render(buffer.area, &mut buffer);
// renders
"┌A─────B─────C┐",
"│ │",
"└D─────E─────F┘",
```
Addresses part of https://github.com/ratatui-org/ratatui/issues/738
<!-- Please read CONTRIBUTING.md before submitting any pull request. -->
2202059 (block) Fix crash on empty right aligned title (#933)
- Simplified implementation of the rendering for block.
- Introduces a subtle rendering change where centered titles that are
odd in length will now be rendered one character to the left compared
to before. This aligns with other places that we render centered text
and is a more consistent behavior. See
https://github.com/ratatui-org/ratatui/pull/807#discussion_r1455645954
for another example of this.
Fixes:https://github.com/ratatui-org/ratatui/pull/929
14c67fb (list) Highlight symbol when using a multi-bytes char (#924)
ratatui v0.26.0 brought a regression in the List widget, in which the
highlight symbol width was incorrectly calculated - specifically when
the highlight symbol was a multi-char character, e.g. `▶`.
0dcdbea (paragraph) Render Line::styled correctly inside a paragraph (#930)
Renders the styled graphemes of the line instead of the contained spans.
fae5862 (uncategorized) Ensure that buffer::set_line sets the line style (#926)
Fixes a regression in 0.26 where buffer::set_line was no longer setting
the style. This was due to the new style field on Line instead of being
stored only in the spans.
Also adds a configuration for just running unit tests to bacon.toml.
fbb5dfa (uncategorized) Scrollbar rendering when no track symbols are provided (#911)
61a8278 (canvas) Add documentation to canvas module (#913)
Document the whole `canvas` module. With this, the whole `widgets`
module is documented.
d2d91f7 (changelog) Add sponsors section (#908)
<!-- Please read CONTRIBUTING.md before submitting any pull request. -->
8fb4630 (uncategorized) Remove github action bot that makes comments nudging commit signing (#937)
We can consider reverting this commit once this PR is merged:
https://github.com/1Password/check-signed-commits-action/pull/9
<!-- generated by git-cliff -->
d2d91f7 *(changelog)* Add sponsors section
d2d91f7 (changelog) Add sponsors section (#908)
<!-- Please read CONTRIBUTING.md before submitting any pull request. -->
<!-- generated by git-cliff -->
⚠️ List of breaking changes can be found here.
<img src="https://github.com/ratatui-org.png" >
We are excited to announce the new version of ratatui - a Rust library that's all about cooking up TUIs 🐭
In this version, we have primarily focused on simplifications and quality-of-life improvements for providing a more intuitive and user-friendly experience while building TUIs.
✨ Release highlights: https://ratatui.rs/highlights/v026/
⚠️ List of breaking changes can be found here.
💖 Consider sponsoring us at https://github.com/sponsors/ratatui-org!
79ceb9f (line) Add alignment convenience functions (#856)
This adds convenience functions `left_aligned()`, `centered()` and
`right_aligned()` plus unit tests. Updated example code.
0df9354 (padding) Add new constructors for padding (#828)
Adds `proportional`, `symmetric`, `left`, `right`, `top`, and `bottom`
constructors for Padding struct.
Proportional is
```
/// **NOTE**: Terminal cells are often taller than they are wide, so to make horizontal and vertical
/// padding seem equal, doubling the horizontal padding is usually pretty good.
```
Fixes:https://github.com/ratatui-org/ratatui/issues/798
d726e92 (paragraph) Add alignment convenience functions (#866)
Added convenience functions left_aligned(), centered() and
right_aligned() plus unit tests. Updated example code.
c1ed5c3 (span) Add alignment functions (#873)
Implemented functions that convert Span into a
left-/center-/right-aligned Line. Implemented unit tests.
Closes #853
b80264d (text) Add alignment convenience functions (#862)
Adds convenience functions `left_aligned()`, `centered()` and
`right_aligned()` plus unit tests.
23f6938
(block) Add Block::bordered (#736)
This avoid creating a block with no borders and then settings Borders::ALL. i.e.
```diff
- Block::default().borders(Borders::ALL);
+ Block::bordered();
```
ffd5fc7 (color) Add Color::from_u32 constructor (#785)
Convert a u32 in the format 0x00RRGGBB to a Color.
```rust
let white = Color::from_u32(0x00FFFFFF);
let black = Color::from_u32(0x00000000);
```
4f2db82 (color) Use the FromStr implementation for deserialization (#705)
The deserialize implementation for Color used to support only the enum
names (e.g. Color, LightRed, etc.) With this change, you can use any of
the strings supported by the FromStr implementation (e.g. black,
light-red, #00ff00, etc.)
1cbe1f5
(constraints) Rename Constraint::Proportional to Constraint::Fill (#880)
Constraint::Fill is a more intuitive name for the behavior, and it is
shorter.
Resolves #859
dfd6db9 (demo2) Add destroy mode to celebrate commit 1000! (#809)
```shell
cargo run --example demo2 --features="crossterm widget-calendar"
```
Press `d` to activate destroy mode and Enjoy!

Vendors a copy of tui-big-text to allow us to use it in the demo.
540fd2d
(layout) Change Flex::default() (#881) [breaking]
This PR makes a number of simplifications to the layout and constraint
features that were added after v0.25.0.
For users upgrading from v0.25.0, the net effect of this PR (along with
the other PRs) is the following:
- New `Flex` modes have been added.
- `Flex::Start` (new default)
- `Flex::Center`
- `Flex::End`
- `Flex::SpaceAround`
- `Flex::SpaceBetween`
- `Flex::Legacy` (old default)
- `Min(v)` grows to allocate excess space in all `Flex` modes instead of
shrinking (except in `Flex::Legacy` where it retains old behavior).
- `Fill(1)` grows to allocate excess space, growing equally with
`Min(v)`.
---
The following contains a summary of the changes in this PR and the
motivation behind them.
**`Flex`**
- Removes `Flex::Stretch`
- Renames `Flex::StretchLast` to `Flex::Legacy`
**`Constraint`**
- Removes `Fixed`
- Makes `Min(v)` grow as much as possible everywhere (except
`Flex::Legacy` where it retains the old behavior)
- Makes `Min(v)` grow equally as `Fill(1)` while respecting `Min` lower
bounds. When `Fill` and `Min` are used together, they both fill excess
space equally.
Allowing `Min(v)` to grow still allows users to build the same layouts
as before with `Flex::Start` with no breaking changes to the behavior.
This PR also removes the unstable feature `SegmentSize`.
This is a breaking change to the behavior of constraints. If users want
old behavior, they can use `Flex::Legacy`.
```rust
Layout::vertical([Length(25), Length(25)]).flex(Flex::Legacy)
```
Users that have constraint that exceed the available space will probably
not see any difference or see an improvement in their layouts. Any
layout with `Min` will be identical in `Flex::Start` and `Flex::Legacy`
so any layout with `Min` will not be breaking.
Previously, `Table` used `EvenDistribution` internally by default, but
with that gone the default is now `Flex::Start`. This changes the
behavior of `Table` (for the better in most cases). The only way for
users to get exactly the same as the old behavior is to change their
constraints. I imagine most users will be happier out of the box with
the new Table default.
Resolves https://github.com/ratatui-org/ratatui/issues/843
Thanks to @joshka for the direction
bbcfa55 (layout) Add Rect::contains method (#882)
This is useful for performing hit tests (i.e. did the user click in an
area).
1e75596 (layout) Increase default cache size to 500 (#850)
This is a somewhat arbitrary size for the layout cache based on adding
the columns and rows on my laptop's terminal (171+51 = 222) and doubling
it for good measure and then adding a bit more to make it a round
number. This gives enough entries to store a layout for every row and
every column, twice over, which should be enough for most apps. For
those that need more, the cache size can be set with
`Layout::init_cache()`.
Fixes:https://github.com/ratatui-org/ratatui/issues/820
2819eea (layout) Add Position struct (#790)
This stores the x and y coordinates (columns and rows)
- add conversions from Rect
- add conversion with Size to Rect
- add Rect::as_position
1561d64 (layout) Add Rect -> Size conversion methods (#789)
- add Size::new() constructor
- add Rect::as_size()
- impl From<Rect> for Size
- document and add tests for Size
f13fd73
(layout) Add Rect::clamp() method (#749)
* feat(layout): add a Rect::clamp() method
This ensures a rectangle does not end up outside an area. This is useful
when you want to be able to dynamically move a rectangle around, but
keep it constrained to a certain area.
For example, this can be used to implement a draggable window that can
be moved around, but not outside the terminal window.
```rust
let window_area = Rect::new(state.x, state.y, 20, 20).clamp(area);
state.x = rect.x;
state.y = rect.y;
```
* refactor: use rstest to simplify clamp test
* fix: use rstest description instead of string
test layout::rect::tests::clamp::case_01_inside ... ok
test layout::rect::tests::clamp::case_02_up_left ... ok
test layout::rect::tests::clamp::case_04_up_right ... ok
test layout::rect::tests::clamp::case_05_left ... ok
test layout::rect::tests::clamp::case_03_up ... ok
test layout::rect::tests::clamp::case_06_right ... ok
test layout::rect::tests::clamp::case_07_down_left ... ok
test layout::rect::tests::clamp::case_08_down ... ok
test layout::rect::tests::clamp::case_09_down_right ... ok
test layout::rect::tests::clamp::case_10_too_wide ... ok
test layout::rect::tests::clamp::case_11_too_tall ... ok
test layout::rect::tests::clamp::case_12_too_large ... ok
* fix: less ambiguous docs for this / other rect
* fix: move rstest to dev deps
98bcf1c (layout) Add Rect::split method (#729)
This method splits a Rect and returns a fixed-size array of the
resulting Rects. This allows the caller to use array destructuring
to get the individual Rects.
```rust
use Constraint::*;
let layout = &Layout::vertical([Length(1), Min(0)]);
let [top, main] = area.split(&layout);
```
0494ee5 (layout) Accept Into<Constraint> for constructors (#744)
This allows Layout constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a layout, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Layout::new(Direction::Vertical, [1, 2, 3]);
Layout::horizontal([1, 2, 3]);
Layout::vertical([1, 2, 3]);
Layout::default().constraints([1, 2, 3]);
```
7ab12ed (layout) Add horizontal and vertical constructors (#728)
* feat(layout): add vertical and horizontal constructors
This commit adds two new constructors to the `Layout` struct, which
allow the user to create a vertical or horizontal layout with default
values.
```rust
let layout = Layout::vertical([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
let layout = Layout::horizontal([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
```
4278b40 (line) Implement iterators for Line (#896)
This allows iterating over the `Span`s of a line using `for` loops and
other iterator methods.
- add `iter` and `iter_mut` methods to `Line`
- implement `IntoIterator` for `Line`, `&Line`, and `&mut Line` traits
- update call sites to iterate over `Line` rather than `Line::spans`
5d410c6 (line) Implement Widget for Line (#715)
This allows us to use Line as a child of other widgets, and to use
Line::render() to render it rather than calling buffer.set_line().
```rust
frame.render_widget(Line::raw("Hello, world!"), area);
// or
Line::raw("Hello, world!").render(frame, area);
```
c977293 (line) Add style field, setters and docs (#708) [breaking]
- The `Line` struct now stores the style of the line rather than each
`Span` storing it.
- Adds two new setters for style and spans
- Adds missing docs
BREAKING CHANGE:Line::style is now a field of Line instead of being
stored in each Span.
bbf2f90 (rect.rs) Implement Rows and Columns iterators in Rect (#765)
This enables iterating over rows and columns of a Rect. In tern being able to use that with other iterators and simplify looping over cells.
fe06f0c (serde) Support TableState, ListState, and ScrollbarState (#723)
TableState, ListState, and ScrollbarState can now be serialized and deserialized
using serde.
```rust
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct AppState {
list_state: ListState,
table_state: TableState,
scrollbar_state: ScrollbarState,
}
let app_state = AppState::default();
let serialized = serde_json::to_string(app_state);
let app_state = serde_json::from_str(serialized);
```
37c1836 (span) Implement Widget on Span (#709)
This allows us to use Span as a child of other widgets, and to use
Span::render() to render it rather than calling buffer.set_span().
```rust
frame.render_widget(Span::raw("Hello, world!"), area);
// or
Span::raw("Hello, world!").render(frame, area);
// or even
"Hello, world!".green().render(frame, area);
```
e1e85aa (style) Add material design color palette (#786)
The `ratatui::style::palette::material` module contains the Google 2014
Material Design palette.
See https://m2.material.io/design/color/the-color-system.html#tools-for-picking-colors
for more information.
```rust
use ratatui::style::palette::material::BLUE_GRAY;
Line::styled("Hello", BLUE_GRAY.c500);
```
bf67850 (style) Add tailwind color palette (#787)
The `ratatui::style::palette::tailwind` module contains the default
Tailwind color palette. This is useful for styling components with
colors that match the Tailwind color palette.
See https://tailwindcss.com/docs/customizing-colors for more information
on Tailwind.
```rust
use ratatui::style::palette::tailwind::SLATE;
Line::styled("Hello", SLATE.c500);
```
27e9216 (table) Remove allow deprecated attribute used previously for segment_size ✨ (#875)
a489d85 (table) Deprecate SegmentSize on table (#842)
This adds for table:
- Added new flex method with flex field
- Deprecated segment_size method and removed segment_size field
- Updated documentation
- Updated tests
c69ca47
(table) Collect iterator of Row into Table (#774) [breaking]
Any iterator whose item is convertible into `Row` can now be
collected into a `Table`.
Where previously, `Table::new` accepted `IntoIterator<Item = Row>`, it
now accepts `IntoIterator<Item: Into<Row>>`.
BREAKING CHANGE:The compiler can no longer infer the element type of the container
passed to Table::new(). For example, Table::new(vec![], widths)
will no longer compile, as the type of vec![] can no longer be
inferred.
2faa879 (table) Accept Text for highlight_symbol (#781)
This allows for multi-line symbols to be used as the highlight symbol.
```rust
let table = Table::new(rows, widths)
.highlight_symbol(Text::from(vec![
"".into(),
" █ ".into(),
" █ ".into(),
"".into(),
]));
```
e64e194 (table) Implement FromIterator for widgets::Row (#755)
The `Row::new` constructor accepts a single argument that implements
`IntoIterator`. This commit adds an implementation of `FromIterator`,
as a thin wrapper around `Row::new`. This allows `.collect::<Row>()`
to be used at the end of an iterator chain, rather than wrapping the
entire iterator chain in `Row::new`.
803a72d (table) Accept Into<Constraint> for widths (#745)
This allows Table constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a table columns, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Table::new(rows, [1,2,3])
Table::default().widths([1,2,3])
```
f025d2b (table) Add Table::footer and Row::top_margin methods (#722)
* feat(table): Add a Table::footer method
f29c73f
(tabs) Accept Iterators of Line in constructors (#776) [breaking]
Any iterator whose item is convertible into `Line` can now be
collected into `Tabs`.
In addition, where previously `Tabs::new` required a `Vec`, it can now
accept any object that implements `IntoIterator` with an item type
implementing `Into<Line>`.
BREAKING CHANGE:Calls to Tabs::new() whose argument is collected from an iterator
will no longer compile. For example,
Tabs::new(["a","b"].into_iter().collect()) will no longer compile,
because the return type of .collect() can no longer be inferred to
be a Vec<_>.
b459228
(termwiz) Add From termwiz style impls (#726)
Important note: this also fixes a wrong mapping between ratatui's gray
and termwiz's grey. `ratatui::Color::Gray` now maps to
`termwiz::color::AnsiColor::Silver`
9ba7354 (text) Implement iterators for Text (#900)
This allows iterating over the `Lines`s of a text using `for` loops and
other iterator methods.
- add `iter` and `iter_mut` methods to `Text`
- implement `IntoIterator` for `Text`, `&Text`, and `&mut Text` traits
- update call sites to iterate over `Text` rather than `Text::lines`
68d5783 (text) Add style and alignment (#807)
Fixes #758, fixes #801
This PR adds:
style and alignment to TextWidget for TextText manual draw to call for Widget implAll places that use Text have been updated and support its new
features expect paragraph which still has a custom implementation.
815757f (widgets) Implement Widget for Widget refs (#833)
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:https://github.com/ratatui-org/ratatui/discussions/164 Replaces PRs: https://github.com/ratatui-org/ratatui/pull/122 and
https://github.com/ratatui-org/ratatui/pull/16
Enables:https://github.com/ratatui-org/ratatui/issues/132 Validated as a viable working solution by:
https://github.com/ratatui-org/ratatui/pull/836
eb79256
(widgets) Collect iterator of ListItem into List (#775)
Any iterator whose item is convertible into `ListItem` can now be
collected into a `List`.
```rust
let list: List = (0..3).map(|i| format!("Item{i}")).collect();
```
c8dd879 (uncategorized) Add WidgetRef and StatefulWidgetRef traits (#903)
The Widget trait consumes self, which makes it impossible to use in a
boxed context. Previously we implemented the Widget trait for &T, but
this was not enough to render a boxed widget. We now have a new trait
called `WidgetRef` that allows rendering a widget by reference. This
trait is useful when you want to store a reference to one or more
widgets and render them later. Additionally this makes it possible to
render boxed widgets where the type is not known at compile time (e.g.
in a composite layout with multiple panes of different types).
This change also adds a new trait called `StatefulWidgetRef` which is
the stateful equivalent of `WidgetRef`.
Both new traits are gated behind the `unstable-widget-ref` feature flag
as we may change the exact name / approach a little on this based on
further discussion.
Blanket implementation of `Widget` for `&W` where `W` implements
`WidgetRef` and `StatefulWidget` for `&W` where `W` implements
`StatefulWidgetRef` is provided. This allows you to render a widget by
reference and a stateful widget by reference.
A blanket implementation of `WidgetRef` for `Option<W>` where `W`
implements `WidgetRef` is provided. This makes it easier to render
child widgets that are optional without the boilerplate of unwrapping
the option. Previously several widgets implemented this manually. This
commits expands the pattern to apply to all widgets.
```rust
struct Parent {
child: Option<Child>,
}
impl WidgetRef for Parent {
fn render_ref(&self, area: Rect, buf: &mut Buffer) {
self.child.render_ref(area, buf);
}
}
```
```rust
let widgets: Vec<Box<dyn WidgetRef>> = vec![Box::new(Greeting), Box::new(Farewell)];
for widget in widgets {
widget.render_ref(buf.area, &mut buf);
}
assert_eq!(buf, Buffer::with_lines(["Hello Goodbye"]));
```
87bf1dd (uncategorized) Replace Rect::split with Layout::areas and spacers (#904)
In a recent commit we added Rec::split, but this feels more ergonomic as
Layout::areas. This also adds Layout::spacers to get the spacers between
the areas.
dab08b9 (uncategorized) Show space constrained UIs conditionally (#895)
With this PR the constraint explorer demo only shows space constrained
UIs instead:
Smallest (15 row height):
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/37a4a027-6c6d-4feb-8104-d732aee298ac">
Small (20 row height):
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/f76e025f-0061-4f09-9c91-2f7b00fcfb9e">
Medium (30 row height):
<img width="758" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/81b070da-1bfb-40c5-9fbc-c1ab44ce422e">
Full (40 row height):
<img width="760" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/7bb8a8c4-1a77-4bbc-a346-c8b5c198c6d3">
2a12f7b (uncategorized) Impl Widget for &BarChart (#897)
BarChart had some internal mutations that needed to be removed to
implement the Widget trait for &BarChart to bring it in line with the
other widgets.
9ec43ef (uncategorized) Constraint Explorer example (#893)
Here's a constraint explorer demo put together with @joshka
https://github.com/ratatui-org/ratatui/assets/1813121/08d7d8f6-d013-44b4-8331-f4eee3589cce
It allows users to interactive explore how the constraints behave with respect to each other and compare that across flex modes. It allows users to swap constraints out for other constraints, increment or decrement the values, add and remove constraints, and add spacing
It is also a good example for how to structure a simple TUI with several Ratatui code patterns that are useful for refactoring.
Fixes:https://github.com/ratatui-org/ratatui/issues/792
4ee4e6d
(uncategorized) Make spacing work in Flex::SpaceAround and Flex::SpaceBetween (#892)
This PR implements user provided spacing gaps for `SpaceAround` and
`SpaceBetween`.
https://github.com/ratatui-org/ratatui/assets/1813121/2e260708-e8a7-48ef-aec7-9cf84b655e91
Now user provided spacing gaps always take priority in all Flex modes.
dd5ca3a (uncategorized) Better weights for constraints (#889)
This PR is a split of reworking the weights from #888
This keeps the same ranking of weights, just uses a different numerical
value so that the lowest weight is `WEAK` (`1.0`).
No tests are changed as a result of this change, and running the
following multiple times did not cause any errors for me:
```rust
for i in {0..100}
do
cargo test --lib --
if [ $? -ne 0 ]; then
echo "Test failed. Exiting loop."
break
fi
done
```
aeec163 (uncategorized) Change rounding to make tests stable (#888)
This fixes some unstable tests
be4fdaa
(uncategorized) Change priority of constraints and add split_with_spacers ✨ (#788)
Follow up to https://github.com/ratatui-org/ratatui/pull/783
This PR introduces different priorities for each kind of constraint.
This PR also adds tests that specifies this behavior. This PR resolves a
number of broken tests.
Fixes https://github.com/ratatui-org/ratatui/issues/827
With this PR, the layout algorithm will do the following in order:
1. Ensure that all the segments are within the user provided area and
ensure that all segments and spacers are aligned next to each other
2. if a user provides a `layout.spacing`, it will enforce it.
3. ensure proportional elements are all proportional to each other
4. if a user provides a `Fixed(v)` constraint, it will enforce it.
5. `Min` / `Max` binding inequality constraints
6. `Length`
7. `Percentage`
8. `Ratio`
9. collapse `Min` or collapse `Max`
10. grow `Proportional` as much as possible
11. grow spacers as much as possible
This PR also returns the spacer areas as `Rects` to the user. Users can
then draw into the spacers as they see fit (thanks @joshka for the
idea). Here's a screenshot with the modified flex example:
<img width="569" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/46c8901d-882c-43b0-ba87-b1d455099d8f">
This PR introduces a `strengths` module that has "default" weights that
give stable solutions as well as predictable behavior.
d713201
(uncategorized) Add Color::from_hsl ✨ (#772)
This PR adds `Color::from_hsl` that returns a valid `Color::Rgb`.
```rust
let color: Color = Color::from_hsl(360.0, 100.0, 100.0);
assert_eq!(color, Color::Rgb(255, 255, 255));
let color: Color = Color::from_hsl(0.0, 0.0, 0.0);
assert_eq!(color, Color::Rgb(0, 0, 0));
```
HSL stands for Hue (0-360 deg), Saturation (0-100%), and Lightness
(0-100%) and working with HSL the values can be more intuitive. For
example, if you want to make a red color more orange, you can change the
Hue closer toward yellow on the color wheel (i.e. increase the Hue).
Related #763
405a125 (uncategorized) Add wide and tall proportional border set (#848)
Adds `PROPORTIONAL_WIDE` and `PROPORTIONAL_TALL` border sets.
symbols::border::PROPORTIONAL_WIDE
▄▄▄▄
█xx█
█xx█
▀▀▀▀
symbols::border::PROPORTIONAL_TALL
█▀▀█
█xx█
█xx█
█▄▄█
Fixes:https://github.com/ratatui-org/ratatui/issues/834
9df6ceb (uncategorized) Table column calculation uses layout spacing ✨ (#824)
This uses the new `spacing` feature of the `Layout` struct to allocate
columns spacing in the `Table` widget.
This changes the behavior of the table column layout in the following
ways:
1. Selection width is always allocated.
- if a user does not want a selection width ever they should use
`HighlightSpacing::Never`
2. Column spacing is prioritized over other constraints
- if a user does not want column spacing, they should use
`Table::new(...).column_spacing(0)`
---------
f299463 (uncategorized) Add one eighth wide and tall border sets ✨ (#831)
This PR adds the
[`McGugan`](https://www.willmcgugan.com/blog/tech/post/ceo-just-wants-to-draw-boxes/)
border set, which allows for tighter borders.
For example, with the `flex` example you can get this effect (top is
mcgugan wide, bottom is mcgugan tall):
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/756bb50e-f8c3-4eec-abe8-ce358058a526">
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/583485ef-9eb2-4b45-ab88-90bd7cb14c54">
As of this PR, `MCGUGAN_WIDE` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
let cell = buf.get_mut(block.x, block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x, block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
```
`MCGUGAN_TALL` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
for x in block.x + 1..(block.x + block.width).saturating_sub(1) {
let cell = buf.get_mut(x, block.y);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(x, block.y + block.height - 1);
cell.set_style(Style::reset().fg(main_color).reversed());
}
```
ae6a2b0 (uncategorized) Add spacing feature to flex example ✨ (#830)
This adds the `spacing` using `+` and `-` to the flex example
cddf4b2 (uncategorized) Implement Display for Text, Line, Span (#826)
Issue:https://github.com/ratatui-org/ratatui/issues/816
This PR adds:
std::fmt::Display for Text, Line, and Span structs.
Display implementation displays actual content while ignoring style.
5131c81 (uncategorized) Add layout spacing ✨ (#821)
This adds a `spacing` feature for layouts.
Spacing can be added between items of a layout.
de97a1f (uncategorized) Add flex to layout ✨
This PR adds a new way to space elements in a `Layout`.
Loosely based on
[flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/), this
PR adds a `Flex` enum with the following variants:
- Start
- Center
- End
- SpaceAround
- SpaceBetween
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/b744518c-eae7-4e35-bbc4-fe3c95193cde">
It also adds two more variants, to make this backward compatible and to
make it replace `SegmentSize`:
- StretchLast (default in the `Flex` enum, also behavior matches old
default `SegmentSize::LastTakesRemainder`)
- Stretch (behavior matches `SegmentSize::EvenDistribution`)
The `Start` variant from above matches `SegmentSize::None`.
This allows `Flex` to be a complete replacement for `SegmentSize`, hence
this PR also deprecates the `segment_size` constructor on `Layout`.
`SegmentSize` is still used in `Table` but under the hood `segment_size`
maps to `Flex` with all tests passing unchanged.
I also put together a simple example for `Flex` layouts so that I could
test it visually, shared below:
https://github.com/ratatui-org/ratatui/assets/1813121/c8716c59-493f-4631-add5-feecf4bd4e06
9a3815b (uncategorized) Add Constraint::Fixed and Constraint::Proportional ✨ (#783)
425a651 (uncategorized) Add comprehensive tests for Length interacting with other constraints ✨ (#802)
8f56fab (uncategorized) Accept Color and Modifier for all Styles (#720) [breaking]
* feat: accept Color and Modifier for all Styles
All style related methods now accept `S: Into<Style>` instead of
`Style`.
`Color` and `Modifier` implement `Into<Style>` so this is allows for
more ergonomic usage. E.g.:
```rust
Line::styled("hello", Style::new().red());
Line::styled("world", Style::new().bold());
// can now be simplified to
Line::styled("hello", Color::Red);
Line::styled("world", Modifier::BOLD);
Fixes https://github.com/ratatui-org/ratatui/issues/694
BREAKING CHANGE:All style related methods now accept `S: Into<Style>`
instead of `Style`. This means that if you are already passing an
ambiguous type that implements `Into<Style>` you will need to remove
the `.into()` call.
`Block` style methods can no longer be called from a const context as
trait functions cannot (yet) be const.
* feat: add tuple conversions to Style
Adds conversions for various Color and Modifier combinations
* chore: add unit tests
### Bug Fixes
- [ee54493](https://github.com/ratatui-org/ratatui/commit/ee544931633ada25d84daa95e4e3a0b17801cb8b)
*(buffer)* Don't panic in set_style ([#714](https://github.com/ratatui-org/ratatui/issues/714))
````text
This fixes a panic in set_style when the area to be styled is
outside the buffer's bounds.
c959bd2 (calendar) CalendarEventStore panic (#822)
CalendarEventStore::today() panics if the system's UTC offset cannot
be determined. In this circumstance, it's better to use now_utc
instead.
a67815e (chart) Exclude unnamed datasets from legend (#753)
A dataset with no name won't display an empty line anymore in the legend.
If no dataset have name, then no legend is ever displayed.
3e7810a (example) Increase layout cache size (#815)
This was causing very bad performances especially on scrolling.
It's also a good usage demonstration.
50b81c9 (examples/scrollbar) Title wasn't displayed because of background reset (#795)
b3a57f3 (list) Modify List and List example to support saving offsets. (#667)
The current `List` example will unselect and reset the position of a
list.
This PR will save the last selected item, and updates `List` to honor
its offset, preventing the list from resetting when the user
`unselect()`s a `StatefulList`.
6645d2e (table) Ensure that default and new() match (#751) [breaking]
In https://github.com/ratatui-org/ratatui/pull/660 we introduced the
segment_size field to the Table struct. However, we forgot to update
the default() implementation to match the new() implementation. This
meant that the default() implementation picked up SegmentSize::default()
instead of SegmentSize::None.
Additionally the introduction of Table::default() in an earlier PR,
https://github.com/ratatui-org/ratatui/pull/339, was also missing the
default for the column_spacing field (1).
This commit fixes the default() implementation to match the new()
implementation of these two fields by implementing the Default trait
manually.
BREAKING CHANGE:The default() implementation of Table now sets the column_spacing field to 1 and the segment_size field to
SegmentSize::None. This will affect the rendering of a small amount of apps.
b0ed658 (table) Render missing widths as equal (#710)
Previously, if `.widths` was not called before rendering a `Table`, no
content would render in the area of the table. This commit changes that
behaviour to default to equal widths for each column.
Fixes #510.
f71bf18 (uncategorized) Bug with flex stretch with spacing and proportional constraints (#829)
This PR fixes a bug with layouts when using spacing on proportional
constraints.
cc6737b (uncategorized) Make SpaceBetween with one element Stretch 🐛 (#813)
When there's just one element, `SpaceBetween` should do the same thing
as `Stretch`.
f2eab71 (uncategorized) Broken tests in table.rs (#784)
* fix: broken tests in table.rs
* fix: Use default instead of raw
8dd177a (uncategorized) Fix PR write permission to upload unsigned commit comment (#770)
cf86123 (scrollbar) Rewrite scrollbar implementation (#847)
Implementation was simplified and calculates the size of the thumb a
bit more proportionally to the content that is visible.
fd4703c (block) Move padding and title into separate files (#837)
bc274e2
(block) Remove deprecated title_on_bottom (#757) [breaking]
Block::title_on_bottom was deprecated in v0.22. Use Block::title and Title::position instead.
e0aa6c5 (chart) Replace deprecated apply (#812)
Fixes #793
7f42ec9 (colors_rgb) Impl widget on mutable refs (#865)
This commit refactors the colors_rgb example to implement the Widget
trait on mutable references to the app and its sub-widgets. This allows
the app to update its state while it is being rendered.
Additionally the main and run functions are refactored to be similar to
the other recent examples. This uses a pattern where the App struct has
a `run` method that takes a terminal as an argument, and the main
function is in control of initializing and restoring the terminal and
installing the error hooks.
813f707 (example) Improve constraints and flex examples (#817)
This PR is a follow up to
https://github.com/ratatui-org/ratatui/pull/811.
It improves the UI of the layouts by
- thoughtful accessible color that represent priority in constraints
resolving
- using QUADRANT_OUTSIDE symbol set for block rendering
- adding a scrollbar
- panic handling
- refactoring for readability
to name a few. Here are some example gifs of the outcome:


---------
bb5444f (example) Add scroll to flex example (#811)
This commit adds `scroll` to the flex example. It also adds more examples to showcase how constraints interact. It improves the UI to make it easier to understand and short terminal friendly.
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/30541efc-ecbe-4e28-b4ef-4d5f1dc63fec"/>
---------
6d15b25 (layout) Move the remaining types (#743)
- alignment -> layout/alignment.rs
- corner -> layout/corner.rs
- direction -> layout/direction.rs
- size -> layout/size.rs
659460e (layout) Move SegmentSize to layout/segment_size.rs (#742)
9574198 (line) Reorder methods for natural reading order (#713)
6364533 (table) Split table into multiple files (#718)
At close to 2000 lines of code, the table widget was getting a bit
unwieldy. This commit splits it into multiple files, one for each
struct, and one for the table itself.
Also refactors the table rendering code to be easier to maintain.
5aba988 (terminal) Extract types to files (#760)
Fields on Frame that were private are now pub(crate).
5254795 (uncategorized) Make layout tests a bit easier to understand (#890)
bd6b91c
(uncategorized) Make patch_style & reset_style chainable (#754) [breaking]
Previously, `patch_style` and `reset_style` in `Text`, `Line` and `Span`
were using a mutable reference to `Self`. To be more consistent with
the rest of `ratatui`, which is using fluent setters, these now take
ownership of `Self` and return it.
da6c299 (uncategorized) Extract layout::Constraint to file (#739)
6ecaeed (text) Add overview of the relevant methods (#857)
Add an overview of the relevant methods under `Constructor Methods`, `Setter Methods`, and `Other Methods` subtitles.
4b8e54e (examples) Refactor Tabs example (#861)
- Used a few new techniques from the 0.26 features (ref widgets, text rendering,
dividers / padding etc.)
- Updated the app to a simpler application approach
- Use color_eyre
- Make it look pretty (colors, new proportional borders)

---------
Fixes https://github.com/ratatui-org/ratatui/issues/819
Co-authored-by: Josh McKinney <joshka@users.noreply.github.com>
5b7ad2a (examples) Update gauge example (#863)
- colored gauges
- removed box borders
- show the difference between ratio / percentage and unicode / no unicode better
- better application approach (consistent with newer examples)
- various changes for 0.26 featuers
- impl `Widget` for `&App`
- use color_eyre
for gauge.tape
- change to get better output from the new code
---------
Fixes: https://github.com/ratatui-org/ratatui/issues/846
Co-authored-by: Josh McKinney <joshka@users.noreply.github.com>
f383625 (examples) Add note about example versions to all examples (#871)
847bacf (examples) Refactor demo2 (#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.
804c841 (examples) Update list example and list.tape (#864)
This PR adds:
- subjectively better-looking list example
- change list example to a todo list example
- status of a TODO can be changed, further info can be seen under the list.
eb1484b (examples) Update tabs example and tabs.tape (#855)
This PR adds:
for tabs.rs
- general refactoring on code
- subjectively better looking front
- add tailwind colors
for tabs.tape
- change to get better output from the new code
Here is the new output:

330a899 (examples) Update table example and table.tape (#840)
In table.rs
- added scrollbar to the table
- colors changed to use style::palette::tailwind
- now colors can be changed with keys (l or →) for the next color, (h or
←) for the previous color
- added a footer for key info
For table.tape
- typing speed changed to 0.75s from 0.5s
- screen size changed to fit
- pushed keys changed to show the current example better
Fixes:https://github.com/ratatui-org/ratatui/issues/800
41de884 (examples) Document incompatible examples better (#844)
Examples often take advantage of unreleased API changes, which makes
them not copy-paste friendly.
3464894 (examples) Add warning about examples matching the main branch (#778)
fb93db0 (examples) Simplify docs using new layout methods (#731)
Use the new `Layout::horizontal` and `vertical` constructors and
`Rect::split_array` through all the examples.
d6b8513 (examples) Refactor chart example to showcase scatter (#703)
fe84141 (layout) Document the difference in the split methods (#750)
* docs(layout): document the difference in the split methods
* fix: doc suggestion
86168aa
(uncategorized) Fix docstring for Max constraints (#898)
11e4f6a (uncategorized) Adds better documentation for constraints and flex 📚 (#818)
1746a61 (uncategorized) Update links to templates repository 📚 (#810)
This PR updates links to the `templates` repository.
43b2b57 (uncategorized) Fix typo in Table widget description (#797)
2b4aa46 (uncategorized) GitHub admonition syntax for examples README.md (#791)
* docs: GitHub admonition syntax for examples README.md
* docs: Add link to stable release
388aa46 (uncategorized) Update crate, lib and readme links (#771)
Link to the contributing, changelog, and breaking changes docs at the
top of the page instead of just in in the main part of the doc. This
makes it easier to find them.
Rearrange the links to be in a more logical order.
Use link refs for all the links
Fix up the CI link to point to the right workflow
1d3fbc1
(buffer) Apply SSO technique to text buffer in buffer::Cell (#601) [breaking]
Use CompactString instead of String to store the Cell::symbol field.
This saves reduces the size of memory allocations at runtime.
663bbde (layout) Convert layout tests to use rstest (#879)
This PR makes all the letters test use `rstest`
ba20372 (contributing) Remove part about squashing commits (#874)
Removes the part about squashing commits from the CONTRIBUTING file.
We no longer require that because github squashes commits when merging.
This will cleanup the CONTRIBUTING file a bit which is already quite
dense.
d49bbb2 (ci) Update the job description for installing cargo-nextest (#839)
8d77b73 (ci) Use cargo-nextest for running tests (#717)
* chore(ci): use cargo-nextest for running tests
* refactor(make): run library tests before doc tests
b7a4793 (ci) Bump alpha release for breaking changes (#495)
Automatically detect breaking changes based on commit messages
and bump the alpha release number accordingly.
E.g. v0.23.1-alpha.1 will be bumped to v0.24.0-alpha.0 if any commit
since v0.23.0 has a breaking change.
fab943b (contributing) Add deprecation notice guideline (#761)
fc0879f (layout) Comment tests that may fail on occasion (#814)
These fails seem to fail on occasion, locally and on CI.
This issue will be revisited in the PR on constraint weights:
https://github.com/ratatui-org/ratatui/pull/788
f8367fd (uncategorized) Allow Buffer::with_lines to accept IntoIterator (#901)
This can make it easier to use `Buffer::with_lines` with iterators that
don't necessarily produce a `Vec`. For example, this allows using
`Buffer::with_lines` with `&[&str]` directly, without having to call
`collect` on it first.
78f1c14 (uncategorized) Small fixes to constraint-explorer (#894)
984afd5 (uncategorized) Cache dependencies in the CI workflow to speed up builds (#883)
6e76729 (uncategorized) Move example vhs tapes to a folder (#867)
151db6a (uncategorized) Add commit footers to git-cliff config (#805)
Fixes:https://github.com/orhun/git-cliff/issues/297
c24216c (uncategorized) Add comment on PRs with unsigned commits (#768)
Thank you so much to everyone that contributed to this release!
Here is the list of contributors who have contributed to ratatui for the first time!
Shout out to our new sponsors!
BREAKING CHANGE: Line::style is now a field of Line instead of being stored in each Span.
79ceb9f (line) Add alignment convenience functions (#856)
This adds convenience functions `left_aligned()`, `centered()` and
`right_aligned()` plus unit tests. Updated example code.
0df9354 (padding) Add new constructors for padding (#828)
Adds `proportional`, `symmetric`, `left`, `right`, `top`, and `bottom`
constructors for Padding struct.
Proportional is
```
/// **NOTE**: Terminal cells are often taller than they are wide, so to make horizontal and vertical
/// padding seem equal, doubling the horizontal padding is usually pretty good.
```
Fixes: https://github.com/ratatui-org/ratatui/issues/798
d726e92 (paragraph) Add alignment convenience functions (#866)
Added convenience functions left_aligned(), centered() and
right_aligned() plus unit tests. Updated example code.
b80264d (text) Add alignment convenience functions (#862)
Adds convenience functions `left_aligned()`, `centered()` and
`right_aligned()` plus unit tests.
23f6938
(block) Add Block::bordered (#736)
This avoid creating a block with no borders and then settings Borders::ALL. i.e.
```diff
- Block::default().borders(Borders::ALL);
+ Block::bordered();
```
ffd5fc7 (color) Add Color::from_u32 constructor (#785)
Convert a u32 in the format 0x00RRGGBB to a Color.
```rust
let white = Color::from_u32(0x00FFFFFF);
let black = Color::from_u32(0x00000000);
```
4f2db82 (color) Use the FromStr implementation for deserialization (#705)
The deserialize implementation for Color used to support only the enum
names (e.g. Color, LightRed, etc.) With this change, you can use any of
the strings supported by the FromStr implementation (e.g. black,
light-red, #00ff00, etc.)
dfd6db9 (demo2) Add destroy mode to celebrate commit 1000! (#809)
```shell
cargo run --example demo2 --features="crossterm widget-calendar"
```
Press `d` to activate destroy mode and Enjoy!

Vendors a copy of tui-big-text to allow us to use it in the demo.
1e75596 (layout) Increase default cache size to 500 (#850)
This is a somewhat arbitrary size for the layout cache based on adding
the columns and rows on my laptop's terminal (171+51 = 222) and doubling
it for good measure and then adding a bit more to make it a round
number. This gives enough entries to store a layout for every row and
every column, twice over, which should be enough for most apps. For
those that need more, the cache size can be set with
`Layout::init_cache()`.
Fixes: https://github.com/ratatui-org/ratatui/issues/820
2819eea (layout) Add Position struct (#790)
This stores the x and y coordinates (columns and rows)
- add conversions from Rect
- add conversion with Size to Rect
- add Rect::as_position
1561d64 (layout) Add Rect -> Size conversion methods (#789)
- add Size::new() constructor
- add Rect::as_size()
- impl From<Rect> for Size
- document and add tests for Size
f13fd73
(layout) Add Rect::clamp() method (#749)
* feat(layout): add a Rect::clamp() method
This ensures a rectangle does not end up outside an area. This is useful
when you want to be able to dynamically move a rectangle around, but
keep it constrained to a certain area.
For example, this can be used to implement a draggable window that can
be moved around, but not outside the terminal window.
```rust
let window_area = Rect::new(state.x, state.y, 20, 20).clamp(area);
state.x = rect.x;
state.y = rect.y;
```
* refactor: use rstest to simplify clamp test
* fix: use rstest description instead of string
test layout::rect::tests::clamp::case_01_inside ... ok
test layout::rect::tests::clamp::case_02_up_left ... ok
test layout::rect::tests::clamp::case_04_up_right ... ok
test layout::rect::tests::clamp::case_05_left ... ok
test layout::rect::tests::clamp::case_03_up ... ok
test layout::rect::tests::clamp::case_06_right ... ok
test layout::rect::tests::clamp::case_07_down_left ... ok
test layout::rect::tests::clamp::case_08_down ... ok
test layout::rect::tests::clamp::case_09_down_right ... ok
test layout::rect::tests::clamp::case_10_too_wide ... ok
test layout::rect::tests::clamp::case_11_too_tall ... ok
test layout::rect::tests::clamp::case_12_too_large ... ok
* fix: less ambiguous docs for this / other rect
* fix: move rstest to dev deps
98bcf1c (layout) Add Rect::split method (#729)
This method splits a Rect and returns a fixed-size array of the
resulting Rects. This allows the caller to use array destructuring
to get the individual Rects.
```rust
use Constraint::*;
let layout = &Layout::vertical([Length(1), Min(0)]);
let [top, main] = area.split(&layout);
```
0494ee5 (layout) Accept Into<Constraint> for constructors (#744)
This allows Layout constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a layout, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Layout::new(Direction::Vertical, [1, 2, 3]);
Layout::horizontal([1, 2, 3]);
Layout::vertical([1, 2, 3]);
Layout::default().constraints([1, 2, 3]);
```
7ab12ed (layout) Add horizontal and vertical constructors (#728)
* feat(layout): add vertical and horizontal constructors
This commit adds two new constructors to the `Layout` struct, which
allow the user to create a vertical or horizontal layout with default
values.
```rust
let layout = Layout::vertical([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
let layout = Layout::horizontal([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
```
5d410c6 (line) Implement Widget for Line (#715)
This allows us to use Line as a child of other widgets, and to use
Line::render() to render it rather than calling buffer.set_line().
```rust
frame.render_widget(Line::raw("Hello, world!"), area);
// or
Line::raw("Hello, world!").render(frame, area);
```
c977293 (line) Add style field, setters and docs (#708) [breaking]
- The `Line` struct now stores the style of the line rather than each
`Span` storing it.
- Adds two new setters for style and spans
- Adds missing docs
BREAKING CHANGE:
Line::style is now a field of Line instead of being
stored in each Span.
bbf2f90 (rect.rs) Implement Rows and Columns iterators in Rect (#765)
This enables iterating over rows and columns of a Rect. In tern being able to use that with other iterators and simplify looping over cells.
fe06f0c (serde) Support TableState, ListState, and ScrollbarState (#723)
TableState, ListState, and ScrollbarState can now be serialized and deserialized
using serde.
```rust
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct AppState {
list_state: ListState,
table_state: TableState,
scrollbar_state: ScrollbarState,
}
let app_state = AppState::default();
let serialized = serde_json::to_string(app_state);
let app_state = serde_json::from_str(serialized);
```
37c1836 (span) Implement Widget on Span (#709)
This allows us to use Span as a child of other widgets, and to use
Span::render() to render it rather than calling buffer.set_span().
```rust
frame.render_widget(Span::raw("Hello, world!"), area);
// or
Span::raw("Hello, world!").render(frame, area);
// or even
"Hello, world!".green().render(frame, area);
```
e1e85aa (style) Add material design color palette (#786)
The `ratatui::style::palette::material` module contains the Google 2014
Material Design palette.
See https://m2.material.io/design/color/the-color-system.html#tools-for-picking-colors
for more information.
```rust
use ratatui::style::palette::material::BLUE_GRAY;
Line::styled("Hello", BLUE_GRAY.c500);
```
bf67850 (style) Add tailwind color palette (#787)
The `ratatui::style::palette::tailwind` module contains the default
Tailwind color palette. This is useful for styling components with
colors that match the Tailwind color palette.
See https://tailwindcss.com/docs/customizing-colors for more information
on Tailwind.
```rust
use ratatui::style::palette::tailwind::SLATE;
Line::styled("Hello", SLATE.c500);
```
a489d85 (table) Deprecate SegmentSize on table (#842)
This adds for table:
- Added new flex method with flex field
- Deprecated segment_size method and removed segment_size field
- Updated documentation
- Updated tests
c69ca47
(table) Collect iterator of Row into Table (#774) [breaking]
Any iterator whose item is convertible into `Row` can now be
collected into a `Table`.
Where previously, `Table::new` accepted `IntoIterator<Item = Row>`, it
now accepts `IntoIterator<Item: Into<Row>>`.
BREAKING CHANGE:
The compiler can no longer infer the element type of the container
passed to Table::new(). For example, Table::new(vec![], widths)
will no longer compile, as the type of vec![] can no longer be
inferred.
2faa879 (table) Accept Text for highlight_symbol (#781)
This allows for multi-line symbols to be used as the highlight symbol.
```rust
let table = Table::new(rows, widths)
.highlight_symbol(Text::from(vec![
"".into(),
" █ ".into(),
" █ ".into(),
"".into(),
]));
```
e64e194 (table) Implement FromIterator for widgets::Row (#755)
The `Row::new` constructor accepts a single argument that implements
`IntoIterator`. This commit adds an implementation of `FromIterator`,
as a thin wrapper around `Row::new`. This allows `.collect::<Row>()`
to be used at the end of an iterator chain, rather than wrapping the
entire iterator chain in `Row::new`.
803a72d (table) Accept Into<Constraint> for widths (#745)
This allows Table constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a table columns, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Table::new(rows, [1,2,3])
Table::default().widths([1,2,3])
```
f025d2b (table) Add Table::footer and Row::top_margin methods (#722)
* feat(table): Add a Table::footer method
f29c73f
(tabs) Accept Iterators of Line in constructors (#776) [breaking]
Any iterator whose item is convertible into `Line` can now be
collected into `Tabs`.
In addition, where previously `Tabs::new` required a `Vec`, it can now
accept any object that implements `IntoIterator` with an item type
implementing `Into<Line>`.
BREAKING CHANGE:
Calls to Tabs::new() whose argument is collected from an iterator
will no longer compile. For example,
Tabs: :new(["a","b"].into_iter().collect()) will no longer compile,
because the return type of .collect() can no longer be inferred to
be a Vec<_>.
b459228
(termwiz) Add From termwiz style impls (#726)
Important note: this also fixes a wrong mapping between ratatui's gray
and termwiz's grey. `ratatui::Color::Gray` now maps to
`termwiz::color::AnsiColor::Silver`
68d5783 (text) Add style and alignment (#807)
Fixes # 758, fixes #801
This PR adds:
style and alignment to TextWidget for TextText manual draw to call for Widget implAll places that use Text have been updated and support its new
features expect paragraph which still has a custom implementation.
815757f (widgets) Implement Widget for Widget refs (#833)
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: https://github.com/ratatui-org/ratatui/discussions/164 Replaces PRs: https://github.com/ratatui-org/ratatui/pull/122 and
https: //github.com/ratatui-org/ratatui/pull/16
Enables: https://github.com/ratatui-org/ratatui/issues/132 Validated as a viable working solution by:
https: //github.com/ratatui-org/ratatui/pull/836
eb79256
(widgets) Collect iterator of ListItem into List (#775)
Any iterator whose item is convertible into `ListItem` can now be
collected into a `List`.
```rust
let list: List = (0..3).map(|i| format!("Item{i}")).collect();
```
d713201
(uncategorized) Add Color::from_hsl ✨ (#772)
This PR adds `Color::from_hsl` that returns a valid `Color::Rgb`.
```rust
let color: Color = Color::from_hsl(360.0, 100.0, 100.0);
assert_eq!(color, Color::Rgb(255, 255, 255));
let color: Color = Color::from_hsl(0.0, 0.0, 0.0);
assert_eq!(color, Color::Rgb(0, 0, 0));
```
HSL stands for Hue (0-360 deg), Saturation (0-100%), and Lightness
(0-100%) and working with HSL the values can be more intuitive. For
example, if you want to make a red color more orange, you can change the
Hue closer toward yellow on the color wheel (i.e. increase the Hue).
Related # 763
405a125 (uncategorized) Add wide and tall proportional border set (#848)
Adds `PROPORTIONAL_WIDE` and `PROPORTIONAL_TALL` border sets.
symbols: :border::PROPORTIONAL_WIDE
▄▄▄▄
█xx█
█xx█
▀▀▀▀
symbols: :border::PROPORTIONAL_TALL
█▀▀█
█xx█
█xx█
█▄▄█
Fixes: https://github.com/ratatui-org/ratatui/issues/834
9df6ceb (uncategorized) Table column calculation uses layout spacing ✨ (#824)
This uses the new `spacing` feature of the `Layout` struct to allocate
columns spacing in the `Table` widget.
This changes the behavior of the table column layout in the following
ways:
1. Selection width is always allocated.
- if a user does not want a selection width ever they should use
`HighlightSpacing::Never`
2. Column spacing is prioritized over other constraints
- if a user does not want column spacing, they should use
`Table::new(...).column_spacing(0)`
---------
f299463 (uncategorized) Add one eighth wide and tall border sets ✨ (#831)
This PR adds the
[`McGugan`](https://www.willmcgugan.com/blog/tech/post/ceo-just-wants-to-draw-boxes/)
border set, which allows for tighter borders.
For example, with the `flex` example you can get this effect (top is
mcgugan wide, bottom is mcgugan tall):
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/756bb50e-f8c3-4eec-abe8-ce358058a526">
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/583485ef-9eb2-4b45-ab88-90bd7cb14c54">
As of this PR, `MCGUGAN_WIDE` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
let cell = buf.get_mut(block.x, block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x, block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
```
`MCGUGAN_TALL` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
for x in block.x + 1..(block.x + block.width).saturating_sub(1) {
let cell = buf.get_mut(x, block.y);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(x, block.y + block.height - 1);
cell.set_style(Style::reset().fg(main_color).reversed());
}
```
ae6a2b0 (uncategorized) Add spacing feature to flex example ✨ (#830)
This adds the `spacing` using `+` and `-` to the flex example
cddf4b2 (uncategorized) Implement Display for Text, Line, Span (#826)
Issue: https://github.com/ratatui-org/ratatui/issues/816
This PR adds:
std: :fmt::Display for Text, Line, and Span structs.
Display implementation displays actual content while ignoring style.
5131c81 (uncategorized) Add layout spacing ✨ (#821)
This adds a `spacing` feature for layouts.
Spacing can be added between items of a layout.
de97a1f (uncategorized) Add flex to layout ✨
This PR adds a new way to space elements in a `Layout`.
Loosely based on
[flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/), this
PR adds a `Flex` enum with the following variants:
- Start
- Center
- End
- SpaceAround
- SpaceBetween
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/b744518c-eae7-4e35-bbc4-fe3c95193cde">
It also adds two more variants, to make this backward compatible and to
make it replace `SegmentSize`:
- StretchLast (default in the `Flex` enum, also behavior matches old
default `SegmentSize::LastTakesRemainder`)
- Stretch (behavior matches `SegmentSize::EvenDistribution`)
The `Start` variant from above matches `SegmentSize::None`.
This allows `Flex` to be a complete replacement for `SegmentSize`, hence
this PR also deprecates the `segment_size` constructor on `Layout`.
`SegmentSize` is still used in `Table` but under the hood `segment_size`
maps to `Flex` with all tests passing unchanged.
I also put together a simple example for `Flex` layouts so that I could
test it visually, shared below:
https: //github.com/ratatui-org/ratatui/assets/1813121/c8716c59-493f-4631-add5-feecf4bd4e06
9a3815b (uncategorized) Add Constraint::Fixed and Constraint::Proportional ✨ (#783)
425a651 (uncategorized) Add comprehensive tests for Length interacting with other constraints ✨ (#802)
8f56fab (uncategorized) Accept Color and Modifier for all Styles (#720) [breaking]
* feat: accept Color and Modifier for all Styles
All style related methods now accept `S: Into<Style>` instead of
`Style`.
`Color` and `Modifier` implement `Into<Style>` so this is allows for
more ergonomic usage. E.g.:
```rust
Line::styled("hello", Style::new().red());
Line::styled("world", Style::new().bold());
// can now be simplified to
Line: :styled("hello", Color::Red);
Line: :styled("world", Modifier::BOLD);
Fixes https://github.com/ratatui-org/ratatui/issues/694
BREAKING CHANGE:
All style related methods now accept `S: Into<Style>`
instead of `Style`. This means that if you are already passing an
ambiguous type that implements `Into<Style>` you will need to remove
the `.into()` call.
`Block` style methods can no longer be called from a const context as
trait functions cannot (yet) be const.
* feat: add tuple conversions to Style
Adds conversions for various Color and Modifier combinations
* chore: add unit tests
ee54493 (buffer) Don't panic in set_style (#714)
This fixes a panic in set_style when the area to be styled is
outside the buffer's bounds.
c959bd2 (calendar) CalendarEventStore panic (#822)
CalendarEventStore: :today() panics if the system's UTC offset cannot
be determined. In this circumstance, it's better to use now_utc
instead.
a67815e (chart) Exclude unnamed datasets from legend (#753)
A dataset with no name won't display an empty line anymore in the legend.
If no dataset have name, then no legend is ever displayed.
3e7810a (example) Increase layout cache size (#815)
This was causing very bad performances especially on scrolling.
It's also a good usage demonstration.
50b81c9 (examples/scrollbar) Title wasn't displayed because of background reset (#795)
b3a57f3 (list) Modify List and List example to support saving offsets. (#667)
The current `List` example will unselect and reset the position of a
list.
This PR will save the last selected item, and updates `List` to honor
its offset, preventing the list from resetting when the user
`unselect()`s a `StatefulList`.
6645d2e (table) Ensure that default and new() match (#751) [breaking]
In https://github.com/ratatui-org/ratatui/pull/660 we introduced the
segment_size field to the Table struct. However, we forgot to update
the default() implementation to match the new() implementation. This
meant that the default() implementation picked up SegmentSize::default()
instead of SegmentSize::None.
Additionally the introduction of Table::default() in an earlier PR,
https://github.com/ratatui-org/ratatui/pull/339, was also missing the
default for the column_spacing field (1).
This commit fixes the default() implementation to match the new()
implementation of these two fields by implementing the Default trait
manually.
BREAKING CHANGE: The default() implementation of Table now sets the column_spacing field to 1 and the segment_size field to
SegmentSize: :None. This will affect the rendering of a small amount of apps.
b0ed658 (table) Render missing widths as equal (#710)
Previously, if `.widths` was not called before rendering a `Table`, no
content would render in the area of the table. This commit changes that
behaviour to default to equal widths for each column.
Fixes # 510.
f71bf18 (uncategorized) Bug with flex stretch with spacing and proportional constraints (#829)
This PR fixes a bug with layouts when using spacing on proportional
constraints.
cc6737b (uncategorized) Make SpaceBetween with one element Stretch 🐛 (#813)
When there's just one element, `SpaceBetween` should do the same thing
as `Stretch`.
f2eab71 (uncategorized) Broken tests in table.rs (#784)
* fix: broken tests in table.rs
* fix: Use default instead of raw
8dd177a (uncategorized) Fix PR write permission to upload unsigned commit comment (#770)
fd4703c (block) Move padding and title into separate files (#837)
bc274e2
(block) Remove deprecated title_on_bottom (#757) [breaking]
Block: :title_on_bottom was deprecated in v0.22. Use Block::title and Title::position instead.
e0aa6c5 (chart) Replace deprecated apply (#812)
Fixes # 793
7f42ec9 (colors_rgb) Impl widget on mutable refs (#865)
This commit refactors the colors_rgb example to implement the Widget
trait on mutable references to the app and its sub-widgets. This allows
the app to update its state while it is being rendered.
Additionally the main and run functions are refactored to be similar to
the other recent examples. This uses a pattern where the App struct has
a `run` method that takes a terminal as an argument, and the main
function is in control of initializing and restoring the terminal and
installing the error hooks.
813f707 (example) Improve constraints and flex examples (#817)
This PR is a follow up to
https://github.com/ratatui-org/ratatui/pull/811.
It improves the UI of the layouts by
- thoughtful accessible color that represent priority in constraints
resolving
- using QUADRANT_OUTSIDE symbol set for block rendering
- adding a scrollbar
- panic handling
- refactoring for readability
to name a few. Here are some example gifs of the outcome:


---------
bb5444f (example) Add scroll to flex example (#811)
This commit adds `scroll` to the flex example. It also adds more examples to showcase how constraints interact. It improves the UI to make it easier to understand and short terminal friendly.
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/30541efc-ecbe-4e28-b4ef-4d5f1dc63fec"/>
---------
6d15b25 (layout) Move the remaining types (#743)
- alignment -> layout/alignment.rs
- corner -> layout/corner.rs
- direction -> layout/direction.rs
- size -> layout/size.rs
659460e (layout) Move SegmentSize to layout/segment_size.rs (#742)
9574198 (line) Reorder methods for natural reading order (#713)
6364533 (table) Split table into multiple files (#718)
At close to 2000 lines of code, the table widget was getting a bit
unwieldy. This commit splits it into multiple files, one for each
struct, and one for the table itself.
Also refactors the table rendering code to be easier to maintain.
5aba988 (terminal) Extract types to files (#760)
Fields on Frame that were private are now pub(crate).
bd6b91c
(uncategorized) Make patch_style & reset_style chainable (#754) [breaking]
Previously, `patch_style` and `reset_style` in `Text`, `Line` and `Span`
were using a mutable reference to `Self`. To be more consistent with
the rest of `ratatui`, which is using fluent setters, these now take
ownership of `Self` and return it.
da6c299 (uncategorized) Extract layout::Constraint to file (#739)
6ecaeed (text) Add overview of the relevant methods (#857)
Add an overview of the relevant methods under `Constructor Methods`, `Setter Methods`, and `Other Methods` subtitles.
f383625 (examples) Add note about example versions to all examples (#871)
847bacf (examples) Refactor demo2 (#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.
804c841 (examples) Update list example and list.tape (#864)
This PR adds:
- subjectively better-looking list example
- change list example to a todo list example
- status of a TODO can be changed, further info can be seen under the list.
eb1484b (examples) Update tabs example and tabs.tape (#855)
This PR adds:
for tabs.rs
- general refactoring on code
- subjectively better looking front
- add tailwind colors
for tabs.tape
- change to get better output from the new code
Here is the new output:

330a899 (examples) Update table example and table.tape (#840)
In table.rs
- added scrollbar to the table
- colors changed to use style::palette::tailwind
- now colors can be changed with keys (l or →) for the next color, (h or
←) for the previous color
- added a footer for key info
For table.tape
- typing speed changed to 0.75s from 0.5s
- screen size changed to fit
- pushed keys changed to show the current example better
Fixes: https://github.com/ratatui-org/ratatui/issues/800
41de884 (examples) Document incompatible examples better (#844)
Examples often take advantage of unreleased API changes, which makes
them not copy-paste friendly.
3464894 (examples) Add warning about examples matching the main branch (#778)
fb93db0 (examples) Simplify docs using new layout methods (#731)
Use the new `Layout::horizontal` and `vertical` constructors and
`Rect::split_array` through all the examples.
d6b8513 (examples) Refactor chart example to showcase scatter (#703)
fe84141 (layout) Document the difference in the split methods (#750)
* docs(layout): document the difference in the split methods
* fix: doc suggestion
11e4f6a (uncategorized) Adds better documentation for constraints and flex 📚 (#818)
1746a61 (uncategorized) Update links to templates repository 📚 (#810)
This PR updates links to the `templates` repository.
43b2b57 (uncategorized) Fix typo in Table widget description (#797)
2b4aa46 (uncategorized) GitHub admonition syntax for examples README.md (#791)
* docs: GitHub admonition syntax for examples README.md
* docs: Add link to stable release
388aa46 (uncategorized) Update crate, lib and readme links (#771)
Link to the contributing, changelog, and breaking changes docs at the
top of the page instead of just in in the main part of the doc. This
makes it easier to find them.
Rearrange the links to be in a more logical order.
Use link refs for all the links
Fix up the CI link to point to the right workflow
1d3fbc1
(buffer) Apply SSO technique to text buffer in buffer::Cell (#601) [breaking]
Use CompactString instead of String to store the Cell::symbol field.
This saves reduces the size of memory allocations at runtime.
ba20372 (contributing) Remove part about squashing commits (#874)
Removes the part about squashing commits from the CONTRIBUTING file.
We no longer require that because github squashes commits when merging.
This will cleanup the CONTRIBUTING file a bit which is already quite
dense.
d49bbb2 (ci) Update the job description for installing cargo-nextest (#839)
8d77b73 (ci) Use cargo-nextest for running tests (#717)
* chore(ci): use cargo-nextest for running tests
* refactor(make): run library tests before doc tests
b7a4793 (ci) Bump alpha release for breaking changes (#495)
Automatically detect breaking changes based on commit messages
and bump the alpha release number accordingly.
E.g. v0.23.1-alpha.1 will be bumped to v0.24.0-alpha.0 if any commit
since v0.23.0 has a breaking change.
fab943b (contributing) Add deprecation notice guideline (#761)
fc0879f (layout) Comment tests that may fail on occasion (#814)
These fails seem to fail on occasion, locally and on CI.
This issue will be revisited in the PR on constraint weights:
https://github.com/ratatui-org/ratatui/pull/788
6e76729 (uncategorized) Move example vhs tapes to a folder (#867)
151db6a (uncategorized) Add commit footers to git-cliff config (#805)
Fixes: https://github.com/orhun/git-cliff/issues/297
c24216c (uncategorized) Add comment on PRs with unsigned commits (#768)
<!-- generated by git-cliff -->
BREAKING CHANGE: Line::style is now a field of Line instead of being stored in each Span.
0df9354 (padding) Add new constructors for padding (#828)
Adds `proportional`, `symmetric`, `left`, `right`, `top`, and `bottom`
constructors for Padding struct.
Proportional is
```
/// **NOTE**: Terminal cells are often taller than they are wide, so to make horizontal and vertical
/// padding seem equal, doubling the horizontal padding is usually pretty good.
```
Fixes: https://github.com/ratatui-org/ratatui/issues/798
23f6938
(block) Add Block::bordered (#736)
This avoid creating a block with no borders and then settings Borders::ALL. i.e.
```diff
- Block::default().borders(Borders::ALL);
+ Block::bordered();
```
ffd5fc7 (color) Add Color::from_u32 constructor (#785)
Convert a u32 in the format 0x00RRGGBB to a Color.
```rust
let white = Color::from_u32(0x00FFFFFF);
let black = Color::from_u32(0x00000000);
```
4f2db82 (color) Use the FromStr implementation for deserialization (#705)
The deserialize implementation for Color used to support only the enum
names (e.g. Color, LightRed, etc.) With this change, you can use any of
the strings supported by the FromStr implementation (e.g. black,
light-red, #00ff00, etc.)
dfd6db9 (demo2) Add destroy mode to celebrate commit 1000! (#809)
```shell
cargo run --example demo2 --features="crossterm widget-calendar"
```
Press `d` to activate destroy mode and Enjoy!

Vendors a copy of tui-big-text to allow us to use it in the demo.
1e75596 (layout) Increase default cache size to 500 (#850)
This is a somewhat arbitrary size for the layout cache based on adding
the columns and rows on my laptop's terminal (171+51 = 222) and doubling
it for good measure and then adding a bit more to make it a round
number. This gives enough entries to store a layout for every row and
every column, twice over, which should be enough for most apps. For
those that need more, the cache size can be set with
`Layout::init_cache()`.
Fixes: https://github.com/ratatui-org/ratatui/issues/820
2819eea (layout) Add Position struct (#790)
This stores the x and y coordinates (columns and rows)
- add conversions from Rect
- add conversion with Size to Rect
- add Rect::as_position
1561d64 (layout) Add Rect -> Size conversion methods (#789)
- add Size::new() constructor
- add Rect::as_size()
- impl From<Rect> for Size
- document and add tests for Size
f13fd73
(layout) Add Rect::clamp() method (#749)
* feat(layout): add a Rect::clamp() method
This ensures a rectangle does not end up outside an area. This is useful
when you want to be able to dynamically move a rectangle around, but
keep it constrained to a certain area.
For example, this can be used to implement a draggable window that can
be moved around, but not outside the terminal window.
```rust
let window_area = Rect::new(state.x, state.y, 20, 20).clamp(area);
state.x = rect.x;
state.y = rect.y;
```
* refactor: use rstest to simplify clamp test
* fix: use rstest description instead of string
test layout::rect::tests::clamp::case_01_inside ... ok
test layout::rect::tests::clamp::case_02_up_left ... ok
test layout::rect::tests::clamp::case_04_up_right ... ok
test layout::rect::tests::clamp::case_05_left ... ok
test layout::rect::tests::clamp::case_03_up ... ok
test layout::rect::tests::clamp::case_06_right ... ok
test layout::rect::tests::clamp::case_07_down_left ... ok
test layout::rect::tests::clamp::case_08_down ... ok
test layout::rect::tests::clamp::case_09_down_right ... ok
test layout::rect::tests::clamp::case_10_too_wide ... ok
test layout::rect::tests::clamp::case_11_too_tall ... ok
test layout::rect::tests::clamp::case_12_too_large ... ok
* fix: less ambiguous docs for this / other rect
* fix: move rstest to dev deps
98bcf1c (layout) Add Rect::split method (#729)
This method splits a Rect and returns a fixed-size array of the
resulting Rects. This allows the caller to use array destructuring
to get the individual Rects.
```rust
use Constraint::*;
let layout = &Layout::vertical([Length(1), Min(0)]);
let [top, main] = area.split(&layout);
```
0494ee5 (layout) Accept Into<Constraint> for constructors (#744)
This allows Layout constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a layout, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Layout::new(Direction::Vertical, [1, 2, 3]);
Layout::horizontal([1, 2, 3]);
Layout::vertical([1, 2, 3]);
Layout::default().constraints([1, 2, 3]);
```
7ab12ed (layout) Add horizontal and vertical constructors (#728)
* feat(layout): add vertical and horizontal constructors
This commit adds two new constructors to the `Layout` struct, which
allow the user to create a vertical or horizontal layout with default
values.
```rust
let layout = Layout::vertical([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
let layout = Layout::horizontal([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
```
5d410c6 (line) Implement Widget for Line (#715)
This allows us to use Line as a child of other widgets, and to use
Line::render() to render it rather than calling buffer.set_line().
```rust
frame.render_widget(Line::raw("Hello, world!"), area);
// or
Line::raw("Hello, world!").render(frame, area);
```
c977293 (line) Add style field, setters and docs (#708) [breaking]
- The `Line` struct now stores the style of the line rather than each
`Span` storing it.
- Adds two new setters for style and spans
- Adds missing docs
BREAKING CHANGE:
Line::style is now a field of Line instead of being
stored in each Span.
bbf2f90 (rect.rs) Implement Rows and Columns iterators in Rect (#765)
This enables iterating over rows and columns of a Rect. In tern being able to use that with other iterators and simplify looping over cells.
fe06f0c (serde) Support TableState, ListState, and ScrollbarState (#723)
TableState, ListState, and ScrollbarState can now be serialized and deserialized
using serde.
```rust
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct AppState {
list_state: ListState,
table_state: TableState,
scrollbar_state: ScrollbarState,
}
let app_state = AppState::default();
let serialized = serde_json::to_string(app_state);
let app_state = serde_json::from_str(serialized);
```
37c1836 (span) Implement Widget on Span (#709)
This allows us to use Span as a child of other widgets, and to use
Span::render() to render it rather than calling buffer.set_span().
```rust
frame.render_widget(Span::raw("Hello, world!"), area);
// or
Span::raw("Hello, world!").render(frame, area);
// or even
"Hello, world!".green().render(frame, area);
```
e1e85aa (style) Add material design color palette (#786)
The `ratatui::style::palette::material` module contains the Google 2014
Material Design palette.
See https://m2.material.io/design/color/the-color-system.html#tools-for-picking-colors
for more information.
```rust
use ratatui::style::palette::material::BLUE_GRAY;
Line::styled("Hello", BLUE_GRAY.c500);
```
bf67850 (style) Add tailwind color palette (#787)
The `ratatui::style::palette::tailwind` module contains the default
Tailwind color palette. This is useful for styling components with
colors that match the Tailwind color palette.
See https://tailwindcss.com/docs/customizing-colors for more information
on Tailwind.
```rust
use ratatui::style::palette::tailwind::SLATE;
Line::styled("Hello", SLATE.c500);
```
a489d85 (table) Deprecate SegmentSize on table (#842)
This adds for table:
- Added new flex method with flex field
- Deprecated segment_size method and removed segment_size field
- Updated documentation
- Updated tests
c69ca47
(table) Collect iterator of Row into Table (#774) [breaking]
Any iterator whose item is convertible into `Row` can now be
collected into a `Table`.
Where previously, `Table::new` accepted `IntoIterator<Item = Row>`, it
now accepts `IntoIterator<Item: Into<Row>>`.
BREAKING CHANGE:
The compiler can no longer infer the element type of the container
passed to Table::new(). For example, Table::new(vec![], widths)
will no longer compile, as the type of vec![] can no longer be
inferred.
2faa879 (table) Accept Text for highlight_symbol (#781)
This allows for multi-line symbols to be used as the highlight symbol.
```rust
let table = Table::new(rows, widths)
.highlight_symbol(Text::from(vec![
"".into(),
" █ ".into(),
" █ ".into(),
"".into(),
]));
```
e64e194 (table) Implement FromIterator for widgets::Row (#755)
The `Row::new` constructor accepts a single argument that implements
`IntoIterator`. This commit adds an implementation of `FromIterator`,
as a thin wrapper around `Row::new`. This allows `.collect::<Row>()`
to be used at the end of an iterator chain, rather than wrapping the
entire iterator chain in `Row::new`.
803a72d (table) Accept Into<Constraint> for widths (#745)
This allows Table constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a table columns, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Table::new(rows, [1,2,3])
Table::default().widths([1,2,3])
```
f025d2b (table) Add Table::footer and Row::top_margin methods (#722)
* feat(table): Add a Table::footer method
f29c73f
(tabs) Accept Iterators of Line in constructors (#776) [breaking]
Any iterator whose item is convertible into `Line` can now be
collected into `Tabs`.
In addition, where previously `Tabs::new` required a `Vec`, it can now
accept any object that implements `IntoIterator` with an item type
implementing `Into<Line>`.
BREAKING CHANGE:
Calls to Tabs::new() whose argument is collected from an iterator
will no longer compile. For example,
Tabs: :new(["a","b"].into_iter().collect()) will no longer compile,
because the return type of .collect() can no longer be inferred to
be a Vec<_>.
b459228
(termwiz) Add From termwiz style impls (#726)
Important note: this also fixes a wrong mapping between ratatui's gray
and termwiz's grey. `ratatui::Color::Gray` now maps to
`termwiz::color::AnsiColor::Silver`
68d5783 (text) Add style and alignment (#807)
Fixes # 758, fixes #801
This PR adds:
style and alignment to TextWidget for TextText manual draw to call for Widget implAll places that use Text have been updated and support its new
features expect paragraph which still has a custom implementation.
eb79256
(widgets) Collect iterator of ListItem into List (#775)
Any iterator whose item is convertible into `ListItem` can now be
collected into a `List`.
```rust
let list: List = (0..3).map(|i| format!("Item{i}")).collect();
```
405a125 (uncategorized) Add wide and tall proportional border set (#848)
Adds `PROPORTIONAL_WIDE` and `PROPORTIONAL_TALL` border sets.
symbols: :border::PROPORTIONAL_WIDE
▄▄▄▄
█xx█
█xx█
▀▀▀▀
symbols: :border::PROPORTIONAL_TALL
█▀▀█
█xx█
█xx█
█▄▄█
Fixes: https://github.com/ratatui-org/ratatui/issues/834
9df6ceb (uncategorized) Table column calculation uses layout spacing ✨ (#824)
This uses the new `spacing` feature of the `Layout` struct to allocate
columns spacing in the `Table` widget.
This changes the behavior of the table column layout in the following
ways:
1. Selection width is always allocated.
- if a user does not want a selection width ever they should use
`HighlightSpacing::Never`
2. Column spacing is prioritized over other constraints
- if a user does not want column spacing, they should use
`Table::new(...).column_spacing(0)`
---------
f299463 (uncategorized) Add one eighth wide and tall border sets ✨ (#831)
This PR adds the
[`McGugan`](https://www.willmcgugan.com/blog/tech/post/ceo-just-wants-to-draw-boxes/)
border set, which allows for tighter borders.
For example, with the `flex` example you can get this effect (top is
mcgugan wide, bottom is mcgugan tall):
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/756bb50e-f8c3-4eec-abe8-ce358058a526">
<img width="759" alt="image"
src="https://github.com/ratatui-org/ratatui/assets/1813121/583485ef-9eb2-4b45-ab88-90bd7cb14c54">
As of this PR, `MCGUGAN_WIDE` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
let cell = buf.get_mut(block.x, block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x, block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 1);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(block.x + block.width.saturating_sub(1), block.y + 2);
cell.set_style(Style::reset().fg(main_color).reversed());
```
`MCGUGAN_TALL` has to be styled manually, like so:
```rust
let main_color = color_for_constraint(*constraint);
for x in block.x + 1..(block.x + block.width).saturating_sub(1) {
let cell = buf.get_mut(x, block.y);
cell.set_style(Style::reset().fg(main_color).reversed());
let cell = buf.get_mut(x, block.y + block.height - 1);
cell.set_style(Style::reset().fg(main_color).reversed());
}
```
ae6a2b0 (uncategorized) Add spacing feature to flex example ✨ (#830)
This adds the `spacing` using `+` and `-` to the flex example
cddf4b2 (uncategorized) Implement Display for Text, Line, Span (#826)
Issue: https://github.com/ratatui-org/ratatui/issues/816
This PR adds:
std: :fmt::Display for Text, Line, and Span structs.
Display implementation displays actual content while ignoring style.
5131c81 (uncategorized) Add layout spacing ✨ (#821)
This adds a `spacing` feature for layouts.
Spacing can be added between items of a layout.
de97a1f (uncategorized) Add flex to layout ✨
This PR adds a new way to space elements in a `Layout`.
Loosely based on
[flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/), this
PR adds a `Flex` enum with the following variants:
- Start
- Center
- End
- SpaceAround
- SpaceBetween
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/b744518c-eae7-4e35-bbc4-fe3c95193cde">
It also adds two more variants, to make this backward compatible and to
make it replace `SegmentSize`:
- StretchLast (default in the `Flex` enum, also behavior matches old
default `SegmentSize::LastTakesRemainder`)
- Stretch (behavior matches `SegmentSize::EvenDistribution`)
The `Start` variant from above matches `SegmentSize::None`.
This allows `Flex` to be a complete replacement for `SegmentSize`, hence
this PR also deprecates the `segment_size` constructor on `Layout`.
`SegmentSize` is still used in `Table` but under the hood `segment_size`
maps to `Flex` with all tests passing unchanged.
I also put together a simple example for `Flex` layouts so that I could
test it visually, shared below:
https: //github.com/ratatui-org/ratatui/assets/1813121/c8716c59-493f-4631-add5-feecf4bd4e06
9a3815b (uncategorized) Add Constraint::Fixed and Constraint::Proportional ✨ (#783)
425a651 (uncategorized) Add comprehensive tests for Length interacting with other constraints ✨ (#802)
8f56fab (uncategorized) Accept Color and Modifier for all Styles (#720) [breaking]
* feat: accept Color and Modifier for all Styles
All style related methods now accept `S: Into<Style>` instead of
`Style`.
`Color` and `Modifier` implement `Into<Style>` so this is allows for
more ergonomic usage. E.g.:
```rust
Line::styled("hello", Style::new().red());
Line::styled("world", Style::new().bold());
// can now be simplified to
Line: :styled("hello", Color::Red);
Line: :styled("world", Modifier::BOLD);
Fixes https://github.com/ratatui-org/ratatui/issues/694
BREAKING CHANGE:
All style related methods now accept `S: Into<Style>`
instead of `Style`. This means that if you are already passing an
ambiguous type that implements `Into<Style>` you will need to remove
the `.into()` call.
`Block` style methods can no longer be called from a const context as
trait functions cannot (yet) be const.
* feat: add tuple conversions to Style
Adds conversions for various Color and Modifier combinations
* chore: add unit tests
ee54493 (buffer) Don't panic in set_style (#714)
This fixes a panic in set_style when the area to be styled is
outside the buffer's bounds.
c959bd2 (calendar) CalendarEventStore panic (#822)
CalendarEventStore: :today() panics if the system's UTC offset cannot
be determined. In this circumstance, it's better to use now_utc
instead.
a67815e (chart) Exclude unnamed datasets from legend (#753)
A dataset with no name won't display an empty line anymore in the legend.
If no dataset have name, then no legend is ever displayed.
3e7810a (example) Increase layout cache size (#815)
This was causing very bad performances especially on scrolling.
It's also a good usage demonstration.
50b81c9 (examples/scrollbar) Title wasn't displayed because of background reset (#795)
b3a57f3 (list) Modify List and List example to support saving offsets. (#667)
The current `List` example will unselect and reset the position of a
list.
This PR will save the last selected item, and updates `List` to honor
its offset, preventing the list from resetting when the user
`unselect()`s a `StatefulList`.
6645d2e (table) Ensure that default and new() match (#751) [breaking]
In https://github.com/ratatui-org/ratatui/pull/660 we introduced the
segment_size field to the Table struct. However, we forgot to update
the default() implementation to match the new() implementation. This
meant that the default() implementation picked up SegmentSize::default()
instead of SegmentSize::None.
Additionally the introduction of Table::default() in an earlier PR,
https://github.com/ratatui-org/ratatui/pull/339, was also missing the
default for the column_spacing field (1).
This commit fixes the default() implementation to match the new()
implementation of these two fields by implementing the Default trait
manually.
BREAKING CHANGE: The default() implementation of Table now sets the column_spacing field to 1 and the segment_size field to
SegmentSize: :None. This will affect the rendering of a small amount of apps.
b0ed658 (table) Render missing widths as equal (#710)
Previously, if `.widths` was not called before rendering a `Table`, no
content would render in the area of the table. This commit changes that
behaviour to default to equal widths for each column.
Fixes # 510.
f71bf18 (uncategorized) Bug with flex stretch with spacing and proportional constraints (#829)
This PR fixes a bug with layouts when using spacing on proportional
constraints.
cc6737b (uncategorized) Make SpaceBetween with one element Stretch 🐛 (#813)
When there's just one element, `SpaceBetween` should do the same thing
as `Stretch`.
f2eab71 (uncategorized) Broken tests in table.rs (#784)
* fix: broken tests in table.rs
* fix: Use default instead of raw
8dd177a (uncategorized) Fix PR write permission to upload unsigned commit comment (#770)
fd4703c (block) Move padding and title into separate files (#837)
bc274e2
(block) Remove deprecated title_on_bottom (#757) [breaking]
Block: :title_on_bottom was deprecated in v0.22. Use Block::title and Title::position instead.
e0aa6c5 (chart) Replace deprecated apply (#812)
Fixes # 793
813f707 (example) Improve constraints and flex examples (#817)
This PR is a follow up to
https://github.com/ratatui-org/ratatui/pull/811.
It improves the UI of the layouts by
- thoughtful accessible color that represent priority in constraints
resolving
- using QUADRANT_OUTSIDE symbol set for block rendering
- adding a scrollbar
- panic handling
- refactoring for readability
to name a few. Here are some example gifs of the outcome:


---------
bb5444f (example) Add scroll to flex example (#811)
This commit adds `scroll` to the flex example. It also adds more examples to showcase how constraints interact. It improves the UI to make it easier to understand and short terminal friendly.
<img width="380" alt="image" src="https://github.com/ratatui-org/ratatui/assets/1813121/30541efc-ecbe-4e28-b4ef-4d5f1dc63fec"/>
---------
6d15b25 (layout) Move the remaining types (#743)
- alignment -> layout/alignment.rs
- corner -> layout/corner.rs
- direction -> layout/direction.rs
- size -> layout/size.rs
659460e (layout) Move SegmentSize to layout/segment_size.rs (#742)
9574198 (line) Reorder methods for natural reading order (#713)
6364533 (table) Split table into multiple files (#718)
At close to 2000 lines of code, the table widget was getting a bit
unwieldy. This commit splits it into multiple files, one for each
struct, and one for the table itself.
Also refactors the table rendering code to be easier to maintain.
5aba988 (terminal) Extract types to files (#760)
Fields on Frame that were private are now pub(crate).
bd6b91c
(uncategorized) Make patch_style & reset_style chainable (#754) [breaking]
Previously, `patch_style` and `reset_style` in `Text`, `Line` and `Span`
were using a mutable reference to `Self`. To be more consistent with
the rest of `ratatui`, which is using fluent setters, these now take
ownership of `Self` and return it.
da6c299 (uncategorized) Extract layout::Constraint to file (#739)
330a899 (examples) Update table example and table.tape (#840)
In table.rs
- added scrollbar to the table
- colors changed to use style::palette::tailwind
- now colors can be changed with keys (l or →) for the next color, (h or
←) for the previous color
- added a footer for key info
For table.tape
- typing speed changed to 0.75s from 0.5s
- screen size changed to fit
- pushed keys changed to show the current example better
Fixes: https://github.com/ratatui-org/ratatui/issues/800
41de884 (examples) Document incompatible examples better (#844)
Examples often take advantage of unreleased API changes, which makes
them not copy-paste friendly.
3464894 (examples) Add warning about examples matching the main branch (#778)
fb93db0 (examples) Simplify docs using new layout methods (#731)
Use the new `Layout::horizontal` and `vertical` constructors and
`Rect::split_array` through all the examples.
d6b8513 (examples) Refactor chart example to showcase scatter (#703)
fe84141 (layout) Document the difference in the split methods (#750)
* docs(layout): document the difference in the split methods
* fix: doc suggestion
11e4f6a (uncategorized) Adds better documentation for constraints and flex 📚 (#818)
1746a61 (uncategorized) Update links to templates repository 📚 (#810)
This PR updates links to the `templates` repository.
43b2b57 (uncategorized) Fix typo in Table widget description (#797)
2b4aa46 (uncategorized) GitHub admonition syntax for examples README.md (#791)
* docs: GitHub admonition syntax for examples README.md
* docs: Add link to stable release
388aa46 (uncategorized) Update crate, lib and readme links (#771)
Link to the contributing, changelog, and breaking changes docs at the
top of the page instead of just in in the main part of the doc. This
makes it easier to find them.
Rearrange the links to be in a more logical order.
Use link refs for all the links
Fix up the CI link to point to the right workflow
1d3fbc1
(buffer) Apply SSO technique to text buffer in buffer::Cell (#601) [breaking]
Use CompactString instead of String to store the Cell::symbol field.
This saves reduces the size of memory allocations at runtime.
d49bbb2 (ci) Update the job description for installing cargo-nextest (#839)
8d77b73 (ci) Use cargo-nextest for running tests (#717)
* chore(ci): use cargo-nextest for running tests
* refactor(make): run library tests before doc tests
b7a4793 (ci) Bump alpha release for breaking changes (#495)
Automatically detect breaking changes based on commit messages
and bump the alpha release number accordingly.
E.g. v0.23.1-alpha.1 will be bumped to v0.24.0-alpha.0 if any commit
since v0.23.0 has a breaking change.
fab943b (contributing) Add deprecation notice guideline (#761)
fc0879f (layout) Comment tests that may fail on occasion (#814)
These fails seem to fail on occasion, locally and on CI.
This issue will be revisited in the PR on constraint weights:
https://github.com/ratatui-org/ratatui/pull/788
151db6a (uncategorized) Add commit footers to git-cliff config (#805)
Fixes: https://github.com/orhun/git-cliff/issues/297
c24216c (uncategorized) Add comment on PRs with unsigned commits (#768)
<!-- generated by git-cliff -->
````text Link to the contributing, changelog, and breaking changes docs at the top of the page instead of just in in the main part of the doc. This ma…
23f6938
(block) Add Block::bordered (#736)
This avoid creating a block with no borders and then settings Borders::ALL. i.e.
```diff
- Block::default().borders(Borders::ALL);
+ Block::bordered();
```
ffd5fc7 (color) Add Color::from_u32 constructor (#785)
Convert a u32 in the format 0x00RRGGBB to a Color.
```rust
let white = Color::from_u32(0x00FFFFFF);
let black = Color::from_u32(0x00000000);
```
4f2db82 (color) Use the FromStr implementation for deserialization (#705)
The deserialize implementation for Color used to support only the enum
names (e.g. Color, LightRed, etc.) With this change, you can use any of
the strings supported by the FromStr implementation (e.g. black,
light-red, #00ff00, etc.)
1561d64 (layout) Add Rect -> Size conversion methods (#789)
- add Size::new() constructor
- add Rect::as_size()
- impl From<Rect> for Size
- document and add tests for Size
f13fd73
(layout) Add Rect::clamp() method (#749)
* feat(layout): add a Rect::clamp() method
This ensures a rectangle does not end up outside an area. This is useful
when you want to be able to dynamically move a rectangle around, but
keep it constrained to a certain area.
For example, this can be used to implement a draggable window that can
be moved around, but not outside the terminal window.
```rust
let window_area = Rect::new(state.x, state.y, 20, 20).clamp(area);
state.x = rect.x;
state.y = rect.y;
```
* refactor: use rstest to simplify clamp test
* fix: use rstest description instead of string
test layout::rect::tests::clamp::case_01_inside ... ok
test layout::rect::tests::clamp::case_02_up_left ... ok
test layout::rect::tests::clamp::case_04_up_right ... ok
test layout::rect::tests::clamp::case_05_left ... ok
test layout::rect::tests::clamp::case_03_up ... ok
test layout::rect::tests::clamp::case_06_right ... ok
test layout::rect::tests::clamp::case_07_down_left ... ok
test layout::rect::tests::clamp::case_08_down ... ok
test layout::rect::tests::clamp::case_09_down_right ... ok
test layout::rect::tests::clamp::case_10_too_wide ... ok
test layout::rect::tests::clamp::case_11_too_tall ... ok
test layout::rect::tests::clamp::case_12_too_large ... ok
* fix: less ambiguous docs for this / other rect
* fix: move rstest to dev deps
98bcf1c (layout) Add Rect::split method (#729)
This method splits a Rect and returns a fixed-size array of the
resulting Rects. This allows the caller to use array destructuring
to get the individual Rects.
```rust
use Constraint::*;
let layout = &Layout::vertical([Length(1), Min(0)]);
let [top, main] = area.split(&layout);
```
0494ee5 (layout) Accept Into<Constraint> for constructors (#744)
This allows Layout constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a layout, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Layout::new(Direction::Vertical, [1, 2, 3]);
Layout::horizontal([1, 2, 3]);
Layout::vertical([1, 2, 3]);
Layout::default().constraints([1, 2, 3]);
```
7ab12ed (layout) Add horizontal and vertical constructors (#728)
* feat(layout): add vertical and horizontal constructors
This commit adds two new constructors to the `Layout` struct, which
allow the user to create a vertical or horizontal layout with default
values.
```rust
let layout = Layout::vertical([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
let layout = Layout::horizontal([
Constraint::Length(10),
Constraint::Min(5),
Constraint::Length(10),
]);
```
5d410c6 (line) Implement Widget for Line (#715)
This allows us to use Line as a child of other widgets, and to use
Line::render() to render it rather than calling buffer.set_line().
```rust
frame.render_widget(Line::raw("Hello, world!"), area);
// or
Line::raw("Hello, world!").render(frame, area);
```
c977293 (line) Add style field, setters and docs (#708) [breaking]
- The `Line` struct now stores the style of the line rather than each
`Span` storing it.
- Adds two new setters for style and spans
- Adds missing docs
bbf2f90 (rect.rs) Implement Rows and Columns iterators in Rect (#765)
This enables iterating over rows and columns of a Rect. In tern being able to use that with other iterators and simplify looping over cells.
fe06f0c (serde) Support TableState, ListState, and ScrollbarState (#723)
TableState, ListState, and ScrollbarState can now be serialized and deserialized
using serde.
```rust
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
struct AppState {
list_state: ListState,
table_state: TableState,
scrollbar_state: ScrollbarState,
}
let app_state = AppState::default();
let serialized = serde_json::to_string(app_state);
let app_state = serde_json::from_str(serialized);
```
37c1836 (span) Implement Widget on Span (#709)
This allows us to use Span as a child of other widgets, and to use
Span::render() to render it rather than calling buffer.set_span().
```rust
frame.render_widget(Span::raw("Hello, world!"), area);
// or
Span::raw("Hello, world!").render(frame, area);
// or even
"Hello, world!".green().render(frame, area);
```
e1e85aa (style) Add material design color palette (#786)
The `ratatui::style::palette::material` module contains the Google 2014
Material Design palette.
See https://m2.material.io/design/color/the-color-system.html#tools-for-picking-colors
for more information.
```rust
use ratatui::style::palette::material::BLUE_GRAY;
Line::styled("Hello", BLUE_GRAY.c500);
```
bf67850 (style) Add tailwind color palette (#787)
The `ratatui::style::palette::tailwind` module contains the default
Tailwind color palette. This is useful for styling components with
colors that match the Tailwind color palette.
See https://tailwindcss.com/docs/customizing-colors for more information
on Tailwind.
```rust
use ratatui::style::palette::tailwind::SLATE;
Line::styled("Hello", SLATE.c500);
```
c69ca47
(table) Collect iterator of Row into Table (#774) [breaking]
Any iterator whose item is convertible into `Row` can now be
collected into a `Table`.
Where previously, `Table::new` accepted `IntoIterator<Item = Row>`, it
now accepts `IntoIterator<Item: Into<Row>>`.
2faa879 (table) Accept Text for highlight_symbol (#781)
This allows for multi-line symbols to be used as the highlight symbol.
```rust
let table = Table::new(rows, widths)
.highlight_symbol(Text::from(vec![
"".into(),
" █ ".into(),
" █ ".into(),
"".into(),
]));
```
e64e194 (table) Implement FromIterator for widgets::Row (#755)
The `Row::new` constructor accepts a single argument that implements
`IntoIterator`. This commit adds an implementation of `FromIterator`,
as a thin wrapper around `Row::new`. This allows `.collect::<Row>()`
to be used at the end of an iterator chain, rather than wrapping the
entire iterator chain in `Row::new`.
803a72d (table) Accept Into<Constraint> for widths (#745)
This allows Table constructors to accept any type that implements
Into<Constraint> instead of just AsRef<Constraint>. This is useful when
you want to specify a fixed size for a table columns, but don't want to
explicitly create a Constraint::Length yourself.
```rust
Table::new(rows, [1,2,3])
Table::default().widths([1,2,3])
```
f025d2b (table) Add Table::footer and Row::top_margin methods (#722)
* feat(table): Add a Table::footer method
f29c73f
(tabs) Accept Iterators of Line in constructors (#776) [breaking]
Any iterator whose item is convertible into `Line` can now be
collected into `Tabs`.
In addition, where previously `Tabs::new` required a `Vec`, it can now
accept any object that implements `IntoIterator` with an item type
implementing `Into<Line>`.
b459228
(termwiz) Add From termwiz style impls (#726)
Important note: this also fixes a wrong mapping between ratatui's gray
and termwiz's grey. `ratatui::Color::Gray` now maps to
`termwiz::color::AnsiColor::Silver`
eb79256
(widgets) Collect iterator of ListItem into List (#775)
Any iterator whose item is convertible into `ListItem` can now be
collected into a `List`.
```rust
let list: List = (0..3).map(|i| format!("Item{i}")).collect();
```
8f56fab (uncategorized) Accept Color and Modifier for all Styles (#720) [breaking]
* feat: accept Color and Modifier for all Styles
All style related methods now accept `S: Into<Style>` instead of
`Style`.
`Color` and `Modifier` implement `Into<Style>` so this is allows for
more ergonomic usage. E.g.:
```rust
Line::styled("hello", Style::new().red());
Line::styled("world", Style::new().bold());
// can now be simplified to
ee54493 (buffer) Don't panic in set_style (#714)
This fixes a panic in set_style when the area to be styled is
outside the buffer's bounds.
a67815e (chart) Exclude unnamed datasets from legend (#753)
A dataset with no name won't display an empty line anymore in the legend.
If no dataset have name, then no legend is ever displayed.
50b81c9 (examples/scrollbar) Title wasn't displayed because of background reset (#795)
6645d2e (table) Ensure that default and new() match (#751) [breaking]
In https://github.com/ratatui-org/ratatui/pull/660 we introduced the
segment_size field to the Table struct. However, we forgot to update
the default() implementation to match the new() implementation. This
meant that the default() implementation picked up SegmentSize::default()
instead of SegmentSize::None.
Additionally the introduction of Table::default() in an earlier PR,
https://github.com/ratatui-org/ratatui/pull/339, was also missing the
default for the column_spacing field (1).
This commit fixes the default() implementation to match the new()
implementation of these two fields by implementing the Default trait
manually.
b0ed658 (table) Render missing widths as equal (#710)
Previously, if `.widths` was not called before rendering a `Table`, no
content would render in the area of the table. This commit changes that
behaviour to default to equal widths for each column.
f2eab71 (uncategorized) Broken tests in table.rs (#784)
* fix: broken tests in table.rs
* fix: Use default instead of raw
8dd177a (uncategorized) Fix PR write permission to upload unsigned commit comment (#770)
bc274e2
(block) Remove deprecated title_on_bottom (#757) [breaking]
6d15b25 (layout) Move the remaining types (#743)
- alignment -> layout/alignment.rs
- corner -> layout/corner.rs
- direction -> layout/direction.rs
- size -> layout/size.rs
659460e (layout) Move SegmentSize to layout/segment_size.rs (#742)
9574198 (line) Reorder methods for natural reading order (#713)
6364533 (table) Split table into multiple files (#718)
At close to 2000 lines of code, the table widget was getting a bit
unwieldy. This commit splits it into multiple files, one for each
struct, and one for the table itself.
Also refactors the table rendering code to be easier to maintain.
5aba988 (terminal) Extract types to files (#760)
Fields on Frame that were private are now pub(crate).
bd6b91c
(uncategorized) Make patch_style & reset_style chainable (#754) [breaking]
Previously, `patch_style` and `reset_style` in `Text`, `Line` and `Span`
were using a mutable reference to `Self`. To be more consistent with
the rest of `ratatui`, which is using fluent setters, these now take
ownership of `Self` and return it.
da6c299 (uncategorized) Extract layout::Constraint to file (#739)
3464894 (examples) Add warning about examples matching the main branch (#778)
fb93db0 (examples) Simplify docs using new layout methods (#731)
Use the new `Layout::horizontal` and `vertical` constructors and
`Rect::split_array` through all the examples.
d6b8513 (examples) Refactor chart example to showcase scatter (#703)
fe84141 (layout) Document the difference in the split methods (#750)
* docs(layout): document the difference in the split methods
* fix: doc suggestion
43b2b57 (uncategorized) Fix typo in Table widget description (#797)
2b4aa46 (uncategorized) GitHub admonition syntax for examples README.md (#791)
* docs: GitHub admonition syntax for examples README.md
* docs: Add link to stable release
388aa46 (uncategorized) Update crate, lib and readme links (#771)
Link to the contributing, changelog, and breaking changes docs at the
top of the page instead of just in in the main part of the doc. This
makes it easier to find them.
Rearrange the links to be in a more logical order.
Use link refs for all the links
Fix up the CI link to point to the right workflow
8d77b73 (ci) Use cargo-nextest for running tests (#717)
* chore(ci): use cargo-nextest for running tests
* refactor(make): run library tests before doc tests
b7a4793 (ci) Bump alpha release for breaking changes (#495)
Automatically detect breaking changes based on commit messages
and bump the alpha release number accordingly.
E.g. v0.23.1-alpha.1 will be bumped to v0.24.0-alpha.0 if any commit
since v0.23.0 has a breaking change.
fab943b (contributing) Add deprecation notice guideline (#761)
c24216c (uncategorized) Add comment on PRs with unsigned commits (#768)
<!-- generated by git-cliff -->
One column per quarter.