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.
b7a4793 *(ci)* Bump alpha release for breaking changes
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();
```
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.)
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
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);
```
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
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`
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.
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.
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)
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
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)
<!-- generated by git-cliff -->
Your coding agent can read these notes before it upgrades. Set up the MCP server →
⚠️ List of breaking changes can be found here.
We are thrilled to announce the new version of ratatui - a Rust library that's all about cooking up TUIs 🐭
In this version, we made improvements on widgets such as List, Table and Layout and changed some of the defaults for a better user experience. Also, we renewed our website and updated our documentation/tutorials to get started with ratatui: https://ratatui.rs 🚀
✨ Release highlights: https://ratatui.rs/highlights/v025/
⚠️ List of breaking changes can be found here.
💖 We also enabled GitHub Sponsors for our organization, consider sponsoring us if you like ratatui: https://github.com/sponsors/ratatui-org
aef4956
(list) List::new now accepts IntoIterator<Item = Into<ListItem>> (#672) [breaking]
This allows to build list like
```
List::new(["Item 1", "Item 2"])
```
8bfd666
(paragraph) Add line_count and line_width unstable helper methods
This is an unstable feature that may be removed in the future
1229b96
(rect) Add offset method (#533)
The offset method creates a new Rect that is moved by the amount
specified in the x and y direction. These values can be positive or
negative. This is useful for manual layout tasks.
```rust
let rect = area.offset(Offset { x: 10, y -10 });
```
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
6b2efd0 (layout) Accept IntoIterator for constraints (#663)
Layout and Table now accept IntoIterator for constraints with an Item
that is AsRef<Constraint>. This allows pretty much any collection of
constraints to be passed to the layout functions including arrays,
vectors, slices, and iterators (without having to call collect() on
them).
753e246 (layout) Allow configuring layout fill (#633)
The layout split will generally fill the remaining area when `split()`
is called. This change allows the caller to configure how any extra
space is allocated to the `Rect`s. This is useful for cases where the
caller wants to have a fixed size for one of the `Rect`s, and have the
other `Rect`s fill the remaining space.
For now, the method and enum are marked as unstable because the exact
name is still being bikeshedded. To enable this functionality, add the
`unstable-segment-size` feature flag in your `Cargo.toml`.
To configure the layout to fill the remaining space evenly, use
`Layout::segment_size(SegmentSize::EvenDistribution)`. The default
behavior is `SegmentSize::LastTakesRemainder`, which gives the last
segment the remaining space. `SegmentSize::None` will disable this
behavior. See the docs for `Layout::segment_size()` and
`layout::SegmentSize` for more information.
Fixes https://github.com/ratatui-org/ratatui/issues/536
1e2f0be (layout) Add parameters to Layout::new() (#557) [breaking]
Adds a convenience function to create a layout with a direction and a
list of constraints which are the most common parameters that would be
generally configured using the builder pattern. The constraints can be
passed in as any iterator of constraints.
```rust
let layout = Layout::new(Direction::Horizontal, [
Constraint::Percentage(50),
Constraint::Percentage(50),
]);
```
c862aa5 (list) Support line alignment (#599)
The `List` widget now respects the alignment of `Line`s and renders them as expected.
ebf1f42
(style) Implement From trait for crossterm to Style related structs (#686)
e49385b (table) Add a Table::segment_size method (#660)
It controls how to distribute extra space to an underconstrained table.
The default, legacy behavior is to leave the extra space unused. The
new options are LastTakesRemainder which gets all space to the rightmost
column that can used it, and EvenDistribution which divides it amongst
all columns.
b8f71c0 (widgets/chart) Add option to set the position of legend (#378)
5bf4f52
(uncategorized) Implement From trait for termion to Style related structs (#692)
* feat(termion): implement from termion color
* feat(termion): implement from termion style
* feat(termion): implement from termion `Bg` and `Fg`
d19b266 (uncategorized) Add Constraint helpers (e.g. from_lengths) (#641)
Adds helper methods that convert from iterators of u16 values to the
specific Constraint type. This makes it easy to create constraints like:
```rust
// a fixed layout
let constraints = Constraint::from_lengths([10, 20, 10]);
// a centered layout
let constraints = Constraint::from_ratios([(1, 4), (1, 2), (1, 4)]);
let constraints = Constraint::from_percentages([25, 50, 25]);
// a centered layout with a minimum size
let constraints = Constraint::from_mins([0, 100, 0]);
// a sidebar / main layout with maximum sizes
let constraints = Constraint::from_maxes([30, 200]);
```
f69d57c
(rect) Fix underflow in the Rect::intersection method (#678)
56fc410
(block) Make inner aware of title positions (#657)
Previously, when computing the inner rendering area of a block, all
titles were assumed to be positioned at the top, which caused the
height of the inner area to be miscalculated.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
37c70db (table) Add widths parameter to new() (#664) [breaking]
This prevents creating a table that doesn't actually render anything.
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
34d099c (tabs) Fixup tests broken by semantic merge conflict (#665)
Two changes without any line overlap caused the tabs tests to break
e4579f0 (tabs) Set the default highlight_style (#635) [breaking]
Previously the default highlight_style was set to `Style::default()`,
which meant that the highlight style was the same as the normal style.
This change sets the default highlight_style to reversed text.
28ac55b (tabs) Tab widget now supports custom padding (#629)
The Tab widget now contains padding_left and and padding_right
properties. Those values can be set with functions `padding_left()`,
`padding_right()`, and `padding()` which all accept `Into<Line>`.
Fixes issue https://github.com/ratatui-org/ratatui/issues/502
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
aaeba27 (uncategorized) Truncate table when overflow (#685)
This prevents a panic when rendering an empty right aligned and rightmost table cell
ffa78aa (uncategorized) Add #[must_use] to Style-moving methods (#600)
f767ea7
(list) start_corner is now direction (#673)
The previous name `start_corner` did not communicate clearly the intent of the method.
A new method `direction` and a new enum `ListDirection` were added.
`start_corner` is now deprecated
0576a8a (layout) To natural reading order (#681)
Structs and enums at the top of the file helps show the interaction
between the types without having to find each type in between longer
impl sections.
Also moved the try_split function into the Layout impl as an associated
function and inlined the `layout::split()` which just called try_split.
This makes the code a bit more contained.
4be18ab (readme) Reference awesome-ratatui instead of wiki (#689)
* refactor(readme): link awesome-ratatui instead of wiki
The apps wiki moved to awesome-ratatui
* docs(readme): Update README.md
7ef0afc (widgets) Remove unnecessary dynamic dispatch and heap allocation (#597)
b282a06 (uncategorized) Remove items deprecated since 0.10 (#691) [breaking]
Remove `Axis::title_style` and `Buffer::set_background` which are deprecated since 0.10
7ced7c0 (uncategorized) Define struct WrappedLine instead of anonymous tuple (#608)
It makes the type easier to document, and more obvious for users
1b8b626 (examples) Add animation and FPS counter to colors_rgb (#583)
2169a0d (examples) Add example of half block rendering (#687)
This is a fun example of how to render big text using half blocks
91c67eb (github) Update code owners (#666)
onboard @Valentin271 as maintainer
3ec4e24 (list) Add documentation to the List widget (#669)
Adds documentation to the List widget and all its sub components like `ListState` and `ListItem`
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
2a87251 (security) Add security policy (#676)
* docs: Create SECURITY.md
* Update SECURITY.md
a15c3b2 (uncategorized) Remove deprecated table constructor from breaking changes (#698)
113b4b7 (uncategorized) Rename template links to remove ratatui from name 📚 (#690)
211160c (uncategorized) Remove simple-tui-rs (#651)
This has not been recently and doesn't lead to good code
910ad00 (rustfmt) Enable format_code_in_doc_comments (#695)
This enables more consistently formatted code in doc comments,
especially since ratatui heavily uses fluent setters.
See https://rust-lang.github.io/rustfmt/?version=v1.6.0#format_code_in_doc_comments
d118565 (table) Cleanup docs and builder methods (#638)
- Refactor the `table` module for better top to bottom readability by
putting types first and arranging them in a logical order (Table, Row,
Cell, other).
- Adds new methods for:
- `Table::rows`
- `Row::cells`
- `Cell::new`
- `Cell::content`
- `TableState::new`
- `TableState::selected_mut`
- Makes `HighlightSpacing::should_add` pub(crate) since it's an internal
detail.
- Adds tests for all the new methods and simple property tests for all
the other setter methods.
dd22e72
(uncategorized) Correct "builder methods" in docs and add must_use on widgets setters (#655)
18e19f6 (uncategorized) Fix breaking changes doc versions (#639)
Moves the layout::new change to unreleasedd section and adds the table change
a58cce2 (uncategorized) Disable default benchmarking (#598)
Disables the default benchmarking behaviour for the lib target to fix unrecognized
criterion benchmark arguments.
See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
03401cd (uncategorized) Fix untrusted input in pr check workflow (#680)
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!
18e19f6 *(uncategorized)* Fix breaking changes doc versions
aef4956
(list) List::new now accepts IntoIterator<Item = Into<ListItem>> (#672) [breaking]
This allows to build list like
```
List::new(["Item 1", "Item 2"])
```
8bfd666
(paragraph) Add line_count and line_width unstable helper methods
This is an unstable feature that may be removed in the future
1229b96
(rect) Add offset method (#533)
The offset method creates a new Rect that is moved by the amount
specified in the x and y direction. These values can be positive or
negative. This is useful for manual layout tasks.
```rust
let rect = area.offset(Offset { x: 10, y -10 });
```
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
6b2efd0 (layout) Accept IntoIterator for constraints (#663)
Layout and Table now accept IntoIterator for constraints with an Item
that is AsRef<Constraint>. This allows pretty much any collection of
constraints to be passed to the layout functions including arrays,
vectors, slices, and iterators (without having to call collect() on
them).
753e246 (layout) Allow configuring layout fill (#633)
The layout split will generally fill the remaining area when `split()`
is called. This change allows the caller to configure how any extra
space is allocated to the `Rect`s. This is useful for cases where the
caller wants to have a fixed size for one of the `Rect`s, and have the
other `Rect`s fill the remaining space.
For now, the method and enum are marked as unstable because the exact
name is still being bikeshedded. To enable this functionality, add the
`unstable-segment-size` feature flag in your `Cargo.toml`.
To configure the layout to fill the remaining space evenly, use
`Layout::segment_size(SegmentSize::EvenDistribution)`. The default
behavior is `SegmentSize::LastTakesRemainder`, which gives the last
segment the remaining space. `SegmentSize::None` will disable this
behavior. See the docs for `Layout::segment_size()` and
`layout::SegmentSize` for more information.
Fixes https://github.com/ratatui-org/ratatui/issues/536
1e2f0be (layout) Add parameters to Layout::new() (#557) [breaking]
Adds a convenience function to create a layout with a direction and a
list of constraints which are the most common parameters that would be
generally configured using the builder pattern. The constraints can be
passed in as any iterator of constraints.
```rust
let layout = Layout::new(Direction::Horizontal, [
Constraint::Percentage(50),
Constraint::Percentage(50),
]);
```
c862aa5 (list) Support line alignment (#599)
The `List` widget now respects the alignment of `Line`s and renders them as expected.
ebf1f42
(style) Implement From trait for crossterm to Style related structs (#686)
e49385b (table) Add a Table::segment_size method (#660)
It controls how to distribute extra space to an underconstrained table.
The default, legacy behavior is to leave the extra space unused. The
new options are LastTakesRemainder which gets all space to the rightmost
column that can used it, and EvenDistribution which divides it amongst
all columns.
b8f71c0 (widgets/chart) Add option to set the position of legend (#378)
d19b266 (uncategorized) Add Constraint helpers (e.g. from_lengths) (#641)
Adds helper methods that convert from iterators of u16 values to the
specific Constraint type. This makes it easy to create constraints like:
```rust
// a fixed layout
let constraints = Constraint::from_lengths([10, 20, 10]);
// a centered layout
let constraints = Constraint::from_ratios([(1, 4), (1, 2), (1, 4)]);
let constraints = Constraint::from_percentages([25, 50, 25]);
// a centered layout with a minimum size
let constraints = Constraint::from_mins([0, 100, 0]);
// a sidebar / main layout with maximum sizes
let constraints = Constraint::from_maxes([30, 200]);
```
f69d57c
(rect) Fix underflow in the Rect::intersection method (#678)
56fc410
(block) Make inner aware of title positions (#657)
Previously, when computing the inner rendering area of a block, all
titles were assumed to be positioned at the top, which caused the
height of the inner area to be miscalculated.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
37c70db (table) Add widths parameter to new() (#664) [breaking]
This prevents creating a table that doesn't actually render anything.
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
34d099c (tabs) Fixup tests broken by semantic merge conflict (#665)
Two changes without any line overlap caused the tabs tests to break
e4579f0 (tabs) Set the default highlight_style (#635) [breaking]
Previously the default highlight_style was set to `Style::default()`,
which meant that the highlight style was the same as the normal style.
This change sets the default highlight_style to reversed text.
28ac55b (tabs) Tab widget now supports custom padding (#629)
The Tab widget now contains padding_left and and padding_right
properties. Those values can be set with functions `padding_left()`,
`padding_right()`, and `padding()` whic all accept `Into<Line>`.
Fixes issue https://github.com/ratatui-org/ratatui/issues/502
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
aaeba27 (uncategorized) Truncate table when overflow (#685)
This prevents a panic when rendering an empty right aligned and rightmost table cell
ffa78aa (uncategorized) Add #[must_use] to Style-moving methods (#600)
f767ea7
(list) start_corner is now direction (#673)
The previous name `start_corner` did not communicate clearly the intent of the method.
A new method `direction` and a new enum `ListDirection` were added.
`start_corner` is now deprecated
0576a8a (layout) To natural reading order (#681)
Structs and enums at the top of the file helps show the interaction
between the types without having to find each type in between longer
impl sections.
Also moved the try_split function into the Layout impl as an associated
function and inlined the `layout::split()` which just called try_split.
This makes the code a bit more contained.
4be18ab (readme) Reference awesome-ratatui instead of wiki (#689)
* refactor(readme): link awesome-ratatui instead of wiki
The apps wiki moved to awesome-ratatui
* docs(readme): Update README.md
7ef0afc (widgets) Remove unnecessary dynamic dispatch and heap allocation (#597)
b282a06 (uncategorized) Remove items deprecated since 0.10 (#691) [breaking]
Remove `Axis::title_style` and `Buffer::set_background` which are deprecated since 0.10
7ced7c0 (uncategorized) Define struct WrappedLine instead of anonymous tuple (#608)
It makes the type easier to document, and more obvious for users
2169a0d (examples) Add example of half block rendering (#687)
This is a fun example of how to render big text using half blocks
91c67eb (github) Update code owners (#666)
onboard @Valentin271 as maintainer
3ec4e24 (list) Add documentation to the List widget (#669)
Adds documentation to the List widget and all its sub components like `ListState` and `ListItem`
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
2a87251 (security) Add security policy (#676)
* docs: Create SECURITY.md
* Update SECURITY.md
113b4b7 (uncategorized) Rename template links to remove ratatui from name 📚 (#690)
211160c (uncategorized) Remove simple-tui-rs (#651)
This has not been recently and doesn't lead to good code
d118565 (table) Cleanup docs and builder methods (#638)
- Refactor the `table` module for better top to bottom readability by
putting types first and arranging them in a logical order (Table, Row,
Cell, other).
- Adds new methods for:
- `Table::rows`
- `Row::cells`
- `Cell::new`
- `Cell::content`
- `TableState::new`
- `TableState::selected_mut`
- Makes `HighlightSpacing::should_add` pub(crate) since it's an internal
detail.
- Adds tests for all the new methods and simple property tests for all
the other setter methods.
dd22e72
(uncategorized) Correct "builder methods" in docs and add must_use on widgets setters (#655)
18e19f6 (uncategorized) Fix breaking changes doc versions (#639)
Moves the layout::new change to unreleasedd section and adds the table change
a58cce2 (uncategorized) Disable default benchmarking (#598)
Disables the default benchmarking behaviour for the lib target to fix unrecognized
criterion benchmark arguments.
See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
03401cd (uncategorized) Fix untrusted input in pr check workflow (#680)
<!-- generated by git-cliff -->
18e19f6 *(uncategorized)* Fix breaking changes doc versions
aef4956
(list) List::new now accepts IntoIterator<Item = Into<ListItem>> (#672) [breaking]
This allows to build list like
```
List::new(["Item 1", "Item 2"])
```
8bfd666
(paragraph) Add line_count and line_width unstable helper methods
This is an unstable feature that may be removed in the future
1229b96
(rect) Add offset method (#533)
The offset method creates a new Rect that is moved by the amount
specified in the x and y direction. These values can be positive or
negative. This is useful for manual layout tasks.
```rust
let rect = area.offset(Offset { x: 10, y -10 });
```
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
6b2efd0 (layout) Accept IntoIterator for constraints (#663)
Layout and Table now accept IntoIterator for constraints with an Item
that is AsRef<Constraint>. This allows pretty much any collection of
constraints to be passed to the layout functions including arrays,
vectors, slices, and iterators (without having to call collect() on
them).
753e246 (layout) Allow configuring layout fill (#633)
The layout split will generally fill the remaining area when `split()`
is called. This change allows the caller to configure how any extra
space is allocated to the `Rect`s. This is useful for cases where the
caller wants to have a fixed size for one of the `Rect`s, and have the
other `Rect`s fill the remaining space.
For now, the method and enum are marked as unstable because the exact
name is still being bikeshedded. To enable this functionality, add the
`unstable-segment-size` feature flag in your `Cargo.toml`.
To configure the layout to fill the remaining space evenly, use
`Layout::segment_size(SegmentSize::EvenDistribution)`. The default
behavior is `SegmentSize::LastTakesRemainder`, which gives the last
segment the remaining space. `SegmentSize::None` will disable this
behavior. See the docs for `Layout::segment_size()` and
`layout::SegmentSize` for more information.
Fixes https://github.com/ratatui-org/ratatui/issues/536
1e2f0be (layout) Add parameters to Layout::new() (#557) [breaking]
Adds a convenience function to create a layout with a direction and a
list of constraints which are the most common parameters that would be
generally configured using the builder pattern. The constraints can be
passed in as any iterator of constraints.
```rust
let layout = Layout::new(Direction::Horizontal, [
Constraint::Percentage(50),
Constraint::Percentage(50),
]);
```
c862aa5 (list) Support line alignment (#599)
The `List` widget now respects the alignment of `Line`s and renders them as expected.
e49385b (table) Add a Table::segment_size method (#660)
It controls how to distribute extra space to an underconstrained table.
The default, legacy behavior is to leave the extra space unused. The
new options are LastTakesRemainder which gets all space to the rightmost
column that can used it, and EvenDistribution which divides it amongst
all columns.
56fc410
(block) Make inner aware of title positions (#657)
Previously, when computing the inner rendering area of a block, all
titles were assumed to be positioned at the top, which caused the
height of the inner area to be miscalculated.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
37c70db (table) Add widths parameter to new() (#664) [breaking]
This prevents creating a table that doesn't actually render anything.
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
34d099c (tabs) Fixup tests broken by semantic merge conflict (#665)
Two changes without any line overlap caused the tabs tests to break
e4579f0 (tabs) Set the default highlight_style (#635) [breaking]
Previously the default highlight_style was set to `Style::default()`,
which meant that the highlight style was the same as the normal style.
This change sets the default highlight_style to reversed text.
28ac55b (tabs) Tab widget now supports custom padding (#629)
The Tab widget now contains padding_left and and padding_right
properties. Those values can be set with functions `padding_left()`,
`padding_right()`, and `padding()` whic all accept `Into<Line>`.
Fixes issue https://github.com/ratatui-org/ratatui/issues/502
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
ffa78aa (uncategorized) Add #[must_use] to Style-moving methods (#600)
7ef0afc (widgets) Remove unnecessary dynamic dispatch and heap allocation (#597)
7ced7c0 (uncategorized) Define struct WrappedLine instead of anonymous tuple (#608)
It makes the type easier to document, and more obvious for users
91c67eb (github) Update code owners (#666)
onboard @Valentin271 as maintainer
3ec4e24 (list) Add documentation to the List widget (#669)
Adds documentation to the List widget and all its sub components like `ListState` and `ListItem`
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
211160c (uncategorized) Remove simple-tui-rs (#651)
This has not been recently and doesn't lead to good code
dd22e72
(uncategorized) Correct "builder methods" in docs and add must_use on widgets setters (#655)
18e19f6 (uncategorized) Fix breaking changes doc versions (#639)
Moves the layout::new change to unreleasedd section and adds the table change
a58cce2 (uncategorized) Disable default benchmarking (#598)
Disables the default benchmarking behaviour for the lib target to fix unrecognized
criterion benchmark arguments.
See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
<!-- generated by git-cliff -->
18e19f6 *(uncategorized)* Fix breaking changes doc versions
1229b96
(rect) Add offset method (#533)
The offset method creates a new Rect that is moved by the amount
specified in the x and y direction. These values can be positive or
negative. This is useful for manual layout tasks.
```rust
let rect = area.offset(Offset { x: 10, y -10 });
```
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
1e2f0be (layout) Add parameters to Layout::new() (#557) [breaking]
Adds a convenience function to create a layout with a direction and a
list of constraints which are the most common parameters that would be
generally configured using the builder pattern. The constraints can be
passed in as any iterator of constraints.
```rust
let layout = Layout::new(Direction::Horizontal, [
Constraint::Percentage(50),
Constraint::Percentage(50),
]);
```
c862aa5 (list) Support line alignment (#599)
The `List` widget now respects the alignment of `Line`s and renders them as expected.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
ffa78aa (uncategorized) Add #[must_use] to Style-moving methods (#600)
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
18e19f6 (uncategorized) Fix breaking changes doc versions (#639)
Moves the layout::new change to unreleasedd section and adds the table change
a58cce2 (uncategorized) Disable default benchmarking (#598)
Disables the default benchmarking behaviour for the lib target to fix unrecognized
criterion benchmark arguments.
See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
<!-- generated by git-cliff -->
18e19f6 *(uncategorized)* Fix breaking changes doc versions
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
1e2f0be (layout) Add parameters to Layout::new() (#557) [breaking]
Adds a convenience function to create a layout with a direction and a
list of constraints which are the most common parameters that would be
generally configured using the builder pattern. The constraints can be
passed in as any iterator of constraints.
```rust
let layout = Layout::new(Direction::Horizontal, [
Constraint::Percentage(50),
Constraint::Percentage(50),
]);
```
c862aa5 (list) Support line alignment (#599)
The `List` widget now respects the alignment of `Line`s and renders them as expected.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
ffa78aa (uncategorized) Add #[must_use] to Style-moving methods (#600)
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
18e19f6 (uncategorized) Fix breaking changes doc versions (#639)
Moves the layout::new change to unreleasedd section and adds the table change
a58cce2 (uncategorized) Disable default benchmarking (#598)
Disables the default benchmarking behaviour for the lib target to fix unrecognized
criterion benchmark arguments.
See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
<!-- generated by git-cliff -->
edacaf7 *(buffer)* Deprecate Cell::symbol field
edacaf7
(buffer) Deprecate Cell::symbol field (#624)
The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
allow us to make future changes to the Cell internals such as replacing `String` with
`compact_str`.
ec7b387
(doc) Do not access deprecated Cell::symbol field in doc example (#626)
1f88da7 (table) Fix new clippy lint which triggers on table widths tests (#630)
* fix(table): new clippy lint in 1.74.0 triggers on table widths tests
36d8c53 (table) Widths() now accepts AsRef<[Constraint]> (#628)
This allows passing an array, slice or Vec of constraints, which is more
ergonomic than requiring this to always be a slice.
The following calls now all succeed:
```rust
Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
// widths could also be computed at runtime
let widths = vec![Constraint::Length(5), Constraint::Length(5)];
Table::new(rows).widths(widths.clone());
Table::new(rows).widths(&widths);
```
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
<!-- generated by git-cliff -->
df0eb1f *(terminal)* Insert_before() now accepts lines > terminal height and doesn't add an extra blank line
df0eb1f (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#596)
Fixes issue with inserting content with height>viewport_area.height and adds
the ability to insert content of height>terminal_height
- Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
support testing the changes
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
59b9c32 (codecov) Adjust threshold and noise settings (#615)
Fixes https://github.com/ratatui-org/ratatui/issues/612
<!-- generated by git-cliff -->
a2f2bd5 *(uncategorized)* MSRV is now 1.70.0
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
<!-- generated by git-cliff -->
a2f2bd5 *(uncategorized)* MSRV is now 1.70.0
9f37100 (readme) Update README.md and fix the bug that demo2 cannot run (#595)
Fixes https://github.com/ratatui-org/ratatui/issues/594
<!-- generated by git-cliff -->
In this version, we've introduced features like window size API, enhanced chart rendering, and more. The list of \*breaking changes\* can be found her…
We are excited to announce the new version of ratatui - a Rust library that's all about cooking up TUIs 🐭
In this version, we've introduced features like window size API, enhanced chart rendering, and more. The list of *breaking changes* can be found here ⚠️. Also, we created various tutorials and walkthroughs in Ratatui Book which is available at https://ratatui.rs 🚀
✨ Release highlights: https://ratatui.rs/highlights/v0.24.html
c6c3f88
(backend) Implement common traits for WindowSize (#586)
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
columns / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
301366c (barchart) Render charts smaller than 3 lines (#532)
The bar values are not shown if the value width is equal the bar width
and the bar is height is less than one line
Add an internal structure `LabelInfo` which stores the reserved height
for the labels (0, 1 or 2) and also whether the labels will be shown.
Fixes ratatui-org#513
32e4619 (block) Allow custom symbols for borders (#529) [breaking]
Adds a new `Block::border_set` method that allows the user to specify
the symbols used for the border.
Added two new border types: `BorderType::QuadrantOutside` and
`BorderType::QuadrantInside`. These are used to draw borders using the
unicode quadrant characters (which look like half block "pixels").
```
▛▀▀▜
▌ ▐
▙▄▄▟
▗▄▄▖
▐ ▌
▝▀▀▘
```
Fixes: https://github.com/ratatui-org/ratatui/issues/528
BREAKING CHANGES:
- BorderType::to_line_set is renamed to to_border_set
- BorderType::line_symbols is renamed to border_symbols
4541336 (canvas) Implement half block marker (#550)
* feat(canvas): implement half block marker
A useful technique for the terminal is to use half blocks to draw a grid
of "pixels" on the screen. Because we can set two colors per cell, and
because terminal cells are about twice as tall as they are wide, we can
draw a grid of half blocks that looks like a grid of square pixels.
This commit adds a new `HalfBlock` marker that can be used in the Canvas
widget and the associated HalfBlockGrid.
Also updated demo2 to use the new marker as it looks much nicer.
Adds docs for many of the methods and structs on canvas.
Changes the grid resolution method to return the pixel count
rather than the index of the last pixel.
This is an internal detail with no user impact.
082cbcb (frame) Remove generic Backend parameter (#530) [breaking]
This change simplifies UI code that uses the Frame type. E.g.:
```rust
fn draw<B: Backend>(frame: &mut Frame<B>) {
// ...
}
```
Frame was generic over Backend because it stored a reference to the
terminal in the field. Instead it now directly stores the viewport area
and current buffer. These are provided at creation time and are valid
for the duration of the frame.
BREAKING CHANGE: Frame is no longer generic over Backend. Code that
accepted a Frame<Backend> will now need to accept a Frame.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
cbf86da (rect) Add is_empty() to simplify some common checks (#534)
- add `Rect::is_empty()` that checks whether either height or width == 0
- refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
the module is private and the type is re-exported under the `layout` module.
15641c8
(uncategorized) Add buffer_mut method on Frame ✨ (#548)
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
8d507c4 (backend) Add feature flag for underline-color (#570)
Windows 7 doesn't support the underline color attribute, so we need to
make it optional. This commit adds a feature flag for the underline
color attribute - it is enabled by default, but can be disabled by
passing `--no-default-features` to cargo.
We could specically check for Windows 7 and disable the feature flag
automatically, but I think it's better for this check to be done by the
crossterm crate, since it's the one that actually knows about the
underlying terminal.
To disable the feature flag in an application that supports Windows 7,
add the following to your Cargo.toml:
```toml
ratatui = { version = "0.24.0", default-features = false, features = ["crossterm"] }
```
Fixes https://github.com/ratatui-org/ratatui/issues/555
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
0c52ff4 (gauge) Fix gauge widget colors (#572)
The background colors of the gauge had a workaround for the issue we had
with VHS / TTYD rendering the background color of the gauge. This
workaround is no longer necessary in the updated versions of VHS / TTYD.
Fixes https://github.com/ratatui-org/ratatui/issues/501
11076d0 (rect) Fix arithmetic overflow edge cases (#543)
Fixes https://github.com/ratatui-org/ratatui/issues/258
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
BREAKING CHANGE: This may break some code that expects to call Stylize
methods on `String` values and then use the String value later. This
will now fail to compile because the String is consumed by set_style
instead of a slice being created and consumed.
This can be fixed by cloning the `String`. E.g.:
let s = String::from("hello world");
let line = Line::from(vec![s.red(), s.green()]); // fails to compile
let line = Line::from(vec![s.clone().red(), s.green()]); // works
Fixes https://discord.com/channels/1070692720437383208/1072907135664529508/1148229700821450833
2fd85af (barchart) Simplify internal implementation (#544)
Replace `remove_invisible_groups_and_bars` with `group_ticks`
`group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
It is used for 2 purposes:
1. to get the bar length in ticks for rendering
2. since it delivers only the values of the visible bars, If we zip these values
with the groups and bars, then we will filter out the invisible groups and bars
27c5637 (readme) Fix links to CONTRIBUTING.md and BREAKING-CHANGES.md (#577)
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
e5caf17 (custom_widget) Make button sticky when clicking with mouse (#561)
ad2dc56 (examples) Update examples readme (#576)
remove VHS bug info, tweak colors_rgb image, update some of the instructions. add demo2
b61f65b (examples) Update theme to Aardvark Blue (#574)
This is a nicer theme that makes the colors pop
61af0d9 (examples) Make custom widget example into a button (#539)
The widget also now supports mouse
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
6c7bef8 (uncategorized) Replace colons with dashes in README.md for consistency (#566)
88ae348
(uncategorized) Update Frame docstring to remove reference to generic backend (#564)
089f8ba (uncategorized) Add double quotes to instructions for features (#560)
346e7b4 (uncategorized) Add summary to breaking changes (#549)
401a7a7
(uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#545)
9cfb133 (uncategorized) Document alpha release process (#542)
Fixes https://github.com/ratatui-org/ratatui/issues/412
4548a9b (uncategorized) Add BREAKING-CHANGES.md (#538)
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
c0991cc (uncategorized) Make library and README consistent (#526)
* docs: make library and README consistent
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
- Removed the Contributors section, as it is redundant with the github
contributors list.
- Removed the info about the other backends and replaced it with a
pointer to the documentation.
- add docsrs example, vhs tape and images that will end up in the README
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
a20bd6a (deps) Update lru requirement from 0.11.1 to 0.12.0 (#581)
Updates the requirements on [lru](https://github.com/jeromefroe/lru-rs) to permit the latest version.
- [Changelog](https://github.com/jeromefroe/lru-rs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/jeromefroe/lru-rs/compare/0.11.1...0.12.0)
---
updated-dependencies:
- dependency-name: lru
dependency-type: direct:production
...
5213f78 (deps) Bump actions/checkout from 3 to 4 (#580)
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)
---
updated-dependencies:
- dependency-name: actions/checkout
dependency-type: direct:production
update-type: version-update:semver-major
...
6cbdb06 (examples) Refactor some examples (#578)
* chore(examples): Simplify timeout calculation with `Duration::saturating_sub`
12f9291 (github) Create dependabot.yml (#575)
* chore: Create dependabot.yml
* Update .github/dependabot.yml
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
fbf1a45 (uncategorized) Simplify constraints (#556)
Use bare arrays rather than array refs / Vecs for all constraint
examples.
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
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!
346e7b4 *(uncategorized)* Add summary to breaking changes
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
301366c (barchart) Render charts smaller than 3 lines (#532)
The bar values are not shown if the value width is equal the bar width
and the bar is height is less than one line
Add an internal structure `LabelInfo` which stores the reserved height
for the labels (0, 1 or 2) and also whether the labels will be shown.
Fixes ratatui-org#513
32e4619 (block) Allow custom symbols for borders (#529) [breaking]
Adds a new `Block::border_set` method that allows the user to specify
the symbols used for the border.
Added two new border types: `BorderType::QuadrantOutside` and
`BorderType::QuadrantInside`. These are used to draw borders using the
unicode quadrant characters (which look like half block "pixels").
4541336 (canvas) Implement half block marker (#550)
* feat(canvas): implement half block marker
A useful technique for the terminal is to use half blocks to draw a grid
of "pixels" on the screen. Because we can set two colors per cell, and
because terminal cells are about twice as tall as they are wide, we can
draw a grid of half blocks that looks like a grid of square pixels.
This commit adds a new `HalfBlock` marker that can be used in the Canvas
widget and the associated HalfBlockGrid.
Also updated demo2 to use the new marker as it looks much nicer.
Adds docs for many of the methods and structs on canvas.
Changes the grid resolution method to return the pixel count
rather than the index of the last pixel.
This is an internal detail with no user impact.
082cbcb (frame) Remove generic Backend parameter (#530) [breaking]
This change simplifys UI code that uses the Frame type. E.g.:
```rust
fn draw<B: Backend>(frame: &mut Frame<B>) {
// ...
}
```
Frame was generic over Backend because it stored a reference to the
terminal in the field. Instead it now directly stores the viewport area
and current buffer. These are provided at creation time and are valid
for the duration of the frame.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
cbf86da (rect) Add is_empty() to simplify some common checks (#534)
- add `Rect::is_empty()` that checks whether either height or width == 0
- refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
the module is private and the type is re-exported under the `layout` module.
15641c8
(uncategorized) Add buffer_mut method on Frame ✨ (#548)
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
8d507c4 (backend) Add feature flag for underline-color (#570)
Windows 7 doesn't support the underline color attribute, so we need to
make it optional. This commit adds a feature flag for the underline
color attribute - it is enabled by default, but can be disabled by
passing `--no-default-features` to cargo.
We could specically check for Windows 7 and disable the feature flag
automatically, but I think it's better for this check to be done by the
crossterm crate, since it's the one that actually knows about the
underlying terminal.
To disable the feature flag in an application that supports Windows 7,
add the following to your Cargo.toml:
```toml
ratatui = { version = "0.24.0", default-features = false, features = ["crossterm"] }
```
Fixes https://github.com/ratatui-org/ratatui/issues/555
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
0c52ff4 (gauge) Fix gauge widget colors (#572)
The background colors of the gauge had a workaround for the issue we had
with VHS / TTYD rendering the background color of the gauge. This
workaround is no longer necessary in the updated versions of VHS / TTYD.
Fixes https://github.com/ratatui-org/ratatui/issues/501
11076d0 (rect) Fix arithmetic overflow edge cases (#543)
Fixes https://github.com/ratatui-org/ratatui/issues/258
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
2fd85af (barchart) Simplify internal implementation (#544)
Replace `remove_invisible_groups_and_bars` with `group_ticks`
`group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
It is used for 2 purposes:
1. to get the bar length in ticks for rendering
2. since it delivers only the values of the visible bars, If we zip these values
with the groups and bars, then we will filter out the invisible groups and bars
27c5637 (readme) Fix links to CONTRIBUTING.md and BREAKING-CHANGES.md (#577)
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
e5caf17 (custom_widget) Make button sticky when clicking with mouse (#561)
ad2dc56 (examples) Update examples readme (#576)
remove VHS bug info, tweak colors_rgb image, update some of the instructions. add demo2
b61f65b (examples) Udpate theme to Aardvark Blue (#574)
This is a nicer theme that makes the colors pop
61af0d9 (examples) Make custom widget example into a button (#539)
The widget also now supports mouse
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
6c7bef8 (uncategorized) Replace colons with dashes in README.md for consistency (#566)
88ae348
(uncategorized) Update Frame docstring to remove reference to generic backend (#564)
089f8ba (uncategorized) Add double quotes to instructions for features (#560)
346e7b4 (uncategorized) Add summary to breaking changes (#549)
401a7a7
(uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#545)
9cfb133 (uncategorized) Document alpha release process (#542)
Fixes https://github.com/ratatui-org/ratatui/issues/412
4548a9b (uncategorized) Add BREAKING-CHANGES.md (#538)
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
c0991cc (uncategorized) Make library and README consistent (#526)
* docs: make library and README consistent
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
- Removed the Contributors section, as it is redundant with the github
contributors list.
- Removed the info about the other backends and replaced it with a
pointer to the documentation.
- add docsrs example, vhs tape and images that will end up in the README
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
6cbdb06 (examples) Refactor some examples (#578)
* chore(examples): Simplify timeout calculation with `Duration::saturating_sub`
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
fbf1a45 (uncategorized) Simplify constraints (#556)
Use bare arrays rather than array refs / Vecs for all constraint
examples.
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
346e7b4 *(uncategorized)* Add summary to breaking changes
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
301366c (barchart) Render charts smaller than 3 lines (#532)
The bar values are not shown if the value width is equal the bar width
and the bar is height is less than one line
Add an internal structure `LabelInfo` which stores the reserved height
for the labels (0, 1 or 2) and also whether the labels will be shown.
Fixes ratatui-org#513
32e4619 (block) Allow custom symbols for borders (#529) [breaking]
Adds a new `Block::border_set` method that allows the user to specify
the symbols used for the border.
Added two new border types: `BorderType::QuadrantOutside` and
`BorderType::QuadrantInside`. These are used to draw borders using the
unicode quadrant characters (which look like half block "pixels").
4541336 (canvas) Implement half block marker (#550)
* feat(canvas): implement half block marker
A useful technique for the terminal is to use half blocks to draw a grid
of "pixels" on the screen. Because we can set two colors per cell, and
because terminal cells are about twice as tall as they are wide, we can
draw a grid of half blocks that looks like a grid of square pixels.
This commit adds a new `HalfBlock` marker that can be used in the Canvas
widget and the associated HalfBlockGrid.
Also updated demo2 to use the new marker as it looks much nicer.
Adds docs for many of the methods and structs on canvas.
Changes the grid resolution method to return the pixel count
rather than the index of the last pixel.
This is an internal detail with no user impact.
082cbcb (frame) Remove generic Backend parameter (#530) [breaking]
This change simplifys UI code that uses the Frame type. E.g.:
```rust
fn draw<B: Backend>(frame: &mut Frame<B>) {
// ...
}
```
Frame was generic over Backend because it stored a reference to the
terminal in the field. Instead it now directly stores the viewport area
and current buffer. These are provided at creation time and are valid
for the duration of the frame.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
cbf86da (rect) Add is_empty() to simplify some common checks (#534)
- add `Rect::is_empty()` that checks whether either height or width == 0
- refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
the module is private and the type is re-exported under the `layout` module.
15641c8
(uncategorized) Add buffer_mut method on Frame ✨ (#548)
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
11076d0 (rect) Fix arithmetic overflow edge cases (#543)
Fixes https://github.com/ratatui-org/ratatui/issues/258
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
2fd85af (barchart) Simplify internal implementation (#544)
Replace `remove_invisible_groups_and_bars` with `group_ticks`
`group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
It is used for 2 purposes:
1. to get the bar length in ticks for rendering
2. since it delivers only the values of the visible bars, If we zip these values
with the groups and bars, then we will filter out the invisible groups and bars
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
e5caf17 (custom_widget) Make button sticky when clicking with mouse (#561)
61af0d9 (examples) Make custom widget example into a button (#539)
The widget also now supports mouse
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
6c7bef8 (uncategorized) Replace colons with dashes in README.md for consistency (#566)
88ae348
(uncategorized) Update Frame docstring to remove reference to generic backend (#564)
089f8ba (uncategorized) Add double quotes to instructions for features (#560)
346e7b4 (uncategorized) Add summary to breaking changes (#549)
401a7a7
(uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#545)
9cfb133 (uncategorized) Document alpha release process (#542)
Fixes https://github.com/ratatui-org/ratatui/issues/412
4548a9b (uncategorized) Add BREAKING-CHANGES.md (#538)
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
c0991cc (uncategorized) Make library and README consistent (#526)
* docs: make library and README consistent
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
- Removed the Contributors section, as it is redundant with the github
contributors list.
- Removed the info about the other backends and replaced it with a
pointer to the documentation.
- add docsrs example, vhs tape and images that will end up in the README
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
fbf1a45 (uncategorized) Simplify constraints (#556)
Use bare arrays rather than array refs / Vecs for all constraint
examples.
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
346e7b4 *(uncategorized)* Add summary to breaking changes
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
301366c (barchart) Render charts smaller than 3 lines (#532)
The bar values are not shown if the value width is equal the bar width
and the bar is height is less than one line
Add an internal structure `LabelInfo` which stores the reserved height
for the labels (0, 1 or 2) and also whether the labels will be shown.
Fixes ratatui-org#513
32e4619 (block) Allow custom symbols for borders (#529) [breaking]
Adds a new `Block::border_set` method that allows the user to specify
the symbols used for the border.
Added two new border types: `BorderType::QuadrantOutside` and
`BorderType::QuadrantInside`. These are used to draw borders using the
unicode quadrant characters (which look like half block "pixels").
4541336 (canvas) Implement half block marker (#550)
* feat(canvas): implement half block marker
A useful technique for the terminal is to use half blocks to draw a grid
of "pixels" on the screen. Because we can set two colors per cell, and
because terminal cells are about twice as tall as they are wide, we can
draw a grid of half blocks that looks like a grid of square pixels.
This commit adds a new `HalfBlock` marker that can be used in the Canvas
widget and the associated HalfBlockGrid.
Also updated demo2 to use the new marker as it looks much nicer.
Adds docs for many of the methods and structs on canvas.
Changes the grid resolution method to return the pixel count
rather than the index of the last pixel.
This is an internal detail with no user impact.
082cbcb (frame) Remove generic Backend parameter (#530) [breaking]
This change simplifys UI code that uses the Frame type. E.g.:
```rust
fn draw<B: Backend>(frame: &mut Frame<B>) {
// ...
}
```
Frame was generic over Backend because it stored a reference to the
terminal in the field. Instead it now directly stores the viewport area
and current buffer. These are provided at creation time and are valid
for the duration of the frame.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
cbf86da (rect) Add is_empty() to simplify some common checks (#534)
- add `Rect::is_empty()` that checks whether either height or width == 0
- refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
the module is private and the type is re-exported under the `layout` module.
15641c8
(uncategorized) Add buffer_mut method on Frame ✨ (#548)
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
11076d0 (rect) Fix arithmetic overflow edge cases (#543)
Fixes https://github.com/ratatui-org/ratatui/issues/258
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
2fd85af (barchart) Simplify internal implementation (#544)
Replace `remove_invisible_groups_and_bars` with `group_ticks`
`group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
It is used for 2 purposes:
1. to get the bar length in ticks for rendering
2. since it delivers only the values of the visible bars, If we zip these values
with the groups and bars, then we will filter out the invisible groups and bars
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
e5caf17 (custom_widget) Make button sticky when clicking with mouse (#561)
61af0d9 (examples) Make custom widget example into a button (#539)
The widget also now supports mouse
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
88ae348
(uncategorized) Update Frame docstring to remove reference to generic backend (#564)
089f8ba (uncategorized) Add double quotes to instructions for features (#560)
346e7b4 (uncategorized) Add summary to breaking changes (#549)
401a7a7
(uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#545)
9cfb133 (uncategorized) Document alpha release process (#542)
Fixes https://github.com/ratatui-org/ratatui/issues/412
4548a9b (uncategorized) Add BREAKING-CHANGES.md (#538)
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
c0991cc (uncategorized) Make library and README consistent (#526)
* docs: make library and README consistent
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
- Removed the Contributors section, as it is redundant with the github
contributors list.
- Removed the info about the other backends and replaced it with a
pointer to the documentation.
- add docsrs example, vhs tape and images that will end up in the README
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
fbf1a45 (uncategorized) Simplify constraints (#556)
Use bare arrays rather than array refs / Vecs for all constraint
examples.
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
``text Document the breaking changes in each version. This document is manually curated by summarizing the breaking changes in the changelog. ``
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
301366c (barchart) Render charts smaller than 3 lines (#532)
The bar values are not shown if the value width is equal the bar width
and the bar is height is less than one line
Add an internal structure `LabelInfo` which stores the reserved height
for the labels (0, 1 or 2) and also whether the labels will be shown.
Fixes ratatui-org#513
32e4619 (block) Allow custom symbols for borders (#529) [breaking]
Adds a new `Block::border_set` method that allows the user to specify
the symbols used for the border.
Added two new border types: `BorderType::QuadrantOutside` and
`BorderType::QuadrantInside`. These are used to draw borders using the
unicode quadrant characters (which look like half block "pixels").
082cbcb (frame) Remove generic Backend parameter (#530) [breaking]
This change simplifys UI code that uses the Frame type. E.g.:
```rust
fn draw<B: Backend>(frame: &mut Frame<B>) {
// ...
}
```
Frame was generic over Backend because it stored a reference to the
terminal in the field. Instead it now directly stores the viewport area
and current buffer. These are provided at creation time and are valid
for the duration of the frame.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
cbf86da (rect) Add is_empty() to simplify some common checks (#534)
- add `Rect::is_empty()` that checks whether either height or width == 0
- refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
the module is private and the type is re-exported under the `layout` module.
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
11076d0 (rect) Fix arithmetic overflow edge cases (#543)
Fixes https://github.com/ratatui-org/ratatui/issues/258
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
2fd85af (barchart) Simplify internal implementation (#544)
Replace `remove_invisible_groups_and_bars` with `group_ticks`
`group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
It is used for 2 purposes:
1. to get the bar length in ticks for rendering
2. since it delivers only the values of the visible bars, If we zip these values
with the groups and bars, then we will filter out the invisible groups and bars
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
61af0d9 (examples) Make custom widget example into a button (#539)
The widget also now supports mouse
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
401a7a7
(uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#545)
9cfb133 (uncategorized) Document alpha release process (#542)
Fixes https://github.com/ratatui-org/ratatui/issues/412
4548a9b (uncategorized) Add BREAKING-CHANGES.md (#538)
Document the breaking changes in each version. This document is
manually curated by summarizing the breaking changes in the changelog.
c0991cc (uncategorized) Make library and README consistent (#526)
* docs: make library and README consistent
Generate the bulk of the README from the library documentation, so that
they are consistent using cargo-rdme.
- Removed the Contributors section, as it is redundant with the github
contributors list.
- Removed the info about the other backends and replaced it with a
pointer to the documentation.
- add docsrs example, vhs tape and images that will end up in the README
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
983ea7f *(uncategorized)* Fix check for if breaking change label should be added ♻️
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
d67fa2c
(line) Add Line::raw constructor (#511)
* feat(line): add `Line::raw` constructor
There is already `Span::raw` and `Text::raw` methods
and this commit simply adds `Line::raw` method for symmetry.
Multi-line content is converted to multiple spans with the new line removed
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
c3155a2 (barchart) Add horizontal labels(#518)
Labels were missed in the initial implementation of the horizontal
mode for the BarChart widget. This adds them.
Fixes https://github.com/ratatui-org/ratatui/issues/499
c9b8e7c (barchart) Render value labels with unicode correctly (#515)
An earlier change introduced a bug where the width of value labels with
unicode characters was incorrectly using the string length in bytes
instead of the unicode character count. This reverts the earlier change.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
21303f2 (rect) Prevent overflow in inner() and area() (#523)
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
dd9a8df
(table) Add documentation for block and header methods of the Table widget (#505)
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
5498a88
(spans) Remove deprecated Spans type (#426)
The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
removed.
- `Line` replaces `Spans`
- `Buffer::set_line` replaces `Buffer::set_spans`
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
983ea7f *(uncategorized)* Fix check for if breaking change label should be added ♻️
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
638d596 (layout) Use LruCache for layout cache (#487)
The layout cache now uses a LruCache with default size set to 16 entries.
Previously the cache was backed by a HashMap, and was able to grow
without bounds as a new entry was added for every new combination of
layout parameters.
- Added a new method (`layout::init_cache(usize)`) that allows the cache
size to be changed if necessary. This will only have an effect if it is called
prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
0c7d547 (docs) Don't fail rustdoc due to termion (#503)
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.
This replaces the link to TermionBackend with one that does not fail
during checks.
Fixes https://github.com/ratatui-org/ratatui/issues/498
ebd3680 (stylize) Add Stylize impl for String (#466) [breaking]
Although the `Stylize` trait is already implemented for `&str` which
extends to `String`, it is not implemented for `String` itself. This
commit adds an impl of Stylize that returns a Span<'static> for `String`
so that code can call Stylize methods on temporary `String`s.
E.g. the following now compiles instead of failing with a compile error
about referencing a temporary value:
let s = format!("hello {name}!", "world").red();
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
3cf0b83 (color) Document true color support (#477)
* refactor(style): move Color to separate color mod
* docs(color): document true color support
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
1e20475 (stylize) Improve docs for style shorthands (#491)
The Stylize trait was introduced in 0.22 to make styling less verbose.
This adds a bunch of documentation comments to the style module and
types to make this easier to discover.
42f8169 (terminal) Add docs for terminal module (#486)
- moves the impl Terminal block up to be closer to the type definition
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
d4976d4 (widgets) Update the list of available widgets (#496)
1414fbc (uncategorized) Import prelude::* in doc examples (#490)
This commit adds `prelude::*` all doc examples and widget::* to those
that need it. This is done to highlight the use of the prelude and
simplify the examples.
- Examples in Type and module level comments show all imports and use
`prelude::*` and `widget::*` where possible.
- Function level comments hide imports unless there are imports other
than `prelude::*` and `widget::*`.
74c5244 (uncategorized) Add logo and favicon to docs.rs page (#473)
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
94af2a2 (buffer) Allow with_lines to accept Vec<Into<Line>> (#494)
This allows writing unit tests without having to call set_style on the
expected buffer.
1278131 (changelog) Make the scopes lowercase in the changelog (#479)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
a7bf4b3 (uncategorized) Use modern modules syntax (#492)
Move xxx/mod.rs to xxx.rs
af36282 (uncategorized) Only run check pr action on pull_request_target events (#485)
322e46f (uncategorized) Prevent PR merge with do not merge labels ♻️ (#484)
983ea7f (uncategorized) Fix check for if breaking change label should be added ♻️ (#483)
384e616 (uncategorized) Add a check for if breaking change label should be added ♻️ (#481)
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
d077903 *(backend)* Backend provides window_size, add Size struct
d077903 (backend) Backend provides window_size, add Size struct (#276)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
c8ab2d5 (chart) Use graph style for top line (#462)
A bug in the rendering caused the top line of the chart to be rendered
using the style of the chart, instead of the dataset style. This is
fixed by only setting the style for the width of the text, and not the
entire row.
e098731
(barchart) Add documentation to BarChart (#449)
Add documentation to the `BarChart` widgets and its sub-modules.
5c785b2 (examples) Move example gifs to github (#460)
- A new orphan branch named "images" is created to store the example
images
ca9bcd3 (examples) Add descriptions and update theme (#460)
- Use the OceanicMaterial consistently in examples
51fdcbe (title) Add documentation to title (#443)
This adds documentation for Title and Position
927a5d8 (uncategorized) Fix documentation lint warnings (#450)
82b40be (ci) Improve checking the PR title (#464)
- Use [`action-semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request)
- Allow only reading the PR contents
- Enable merge group
47ae602 (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#459)
343c6cd (lint) Move formatting and doc checks first (#465)
Putting the formatting and doc checks first to ensure that more critical
errors are caught first (e.g. a conventional commit error or typo should
not prevent the formatting and doc checks from running).
c95a75c (makefile) Remove termion dependency from doc lint (#470)
Only build termion on non-windows targets
b996102 (makefile) Add format target (#468)
- add format target to Makefile.toml that actually fixes the formatting
- rename fmt target to lint-format
- rename style-check target to lint-style
- rename typos target to lint-typos
- rename check-docs target to lint-docs
- add section to CONTRIBUTING.md about formatting
572df75 (uncategorized) Put commit id first in changelog (#463)
878b6fc (uncategorized) Ignore benches from code coverage (#461)
<!-- generated by git-cliff -->
*(backend)* Backend provides window_size, add Size struct
(backend) Backend provides window_size, add Size struct (#276) (d077903)
For image (sixel, iTerm2, Kitty...) support that handles graphics in
terms of `Rect` so that the image area can be included in layouts.
For example: an image is loaded with a known pixel-size, and drawn, but
the image protocol has no mechanism of knowing the actual cell/character
area that been drawn on. It is then impossible to skip overdrawing the
area.
Returning the window size in pixel-width / pixel-height, together with
colums / rows, it can be possible to account the pixel size of each cell
/ character, and then known the `Rect` of a given image, and also resize
the image so that it fits exactly in a `Rect`.
Crossterm and termwiz also both return both sizes from one syscall,
while termion does two.
Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
(always zero).
`Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
is why there are `From` implementations between the two.
(title) Add documentation to title (#443) (51fdcbe)
This adds documentation for Title and Position
(uncategorized) Fix documentation lint warnings (#450) (927a5d8)
<!-- generated by git-cliff -->
Here is a blog post that highlights the new features and breaking changes along with a retrospective about the project: https://blog.orhun.dev/ratatui…
We are thrilled to release the new version of ratatui 🐭, the official successor* of tui-rs.
In this version, we improved the existing widgets such as Barchart and Scrollbar. We also made improvements in the testing/internal APIs to provide a smoother testing/development experience. Additionally, we have addressed various bugs and implemented enhancements.
Here is a blog post that highlights the new features and breaking changes along with a retrospective about the project: https://blog.orhun.dev/ratatui-0-23-0
(barchart) Add direction attribute. (horizontal bars support) (#325) (0dca6a6)
* feat(barchart): Add direction attribute
Enable rendering the bars horizontally. In some cases this allow us to
make more efficient use of the available space.
(cell) Add voluntary skipping capability for sixel (#215) (e4bcf78)
> Sixel is a bitmap graphics format supported by terminals.
> "Sixel mode" is entered by sending the sequence ESC+Pq.
> The "String Terminator" sequence ESC+\ exits the mode.
The graphics are then rendered with the top left positioned at the
cursor position.
It is actually possible to render sixels in ratatui with just
`buf.get_mut(x, y).set_symbol("^[Pq ... ^[\")`. But any buffer covering
the "image area" will overwrite the graphics. This is most likely the same
buffer, even though it consists of empty characters `' '`, except for
the top-left character that starts the sequence.
Thus, either the buffer or cells must be specialized to avoid drawing
over the graphics. This patch specializes the `Cell` with a
`set_skip(bool)` method, based on James' patch:
https://github.com/TurtleTheSeaHobo/tui-rs/tree/sixel-support
I unsuccessfully tried specializing the `Buffer`, but as far as I can tell
buffers get merged all the way "up" and thus skipping must be set on the
Cells. Otherwise some kind of "skipping area" state would be required,
which I think is too complicated.
Having access to the buffer now it is possible to skip all cells but the
first one which can then `set_symbol(sixel)`. It is up to the user to
deal with the graphics size and buffer area size. It is possible to get
the terminal's font size in pixels with a syscall.
An image widget for ratatui that uses this `skip` flag is available at
https://github.com/benjajaja/ratatu-image.
(list) Add option to always allocate the "selection" column width (#394) (4d70169)
* feat(list): add option to always allocate the "selection" column width
Before this option was available, selecting a item in a list when nothing was selected
previously made the row layout change (the same applies to unselecting) by adding the width
of the "highlight symbol" in the front of the list, this option allows to configure this
behavior.
* style: change "highlight_spacing" doc comment to use inline code-block for reference
(release) Add automated nightly releases (#359) (aad164a)
* feat(release): add automated nightly releases
* refactor(release): rename the alpha workflow
* refactor(release): simplify the release calculation
(scrollbar) Add optional track symbol (#360) (1727fa5) [breaking]
The track symbol is now optional, simplifying composition with other
widgets.
(table) Add support for line alignment in the table widget (#392) (7748720)
* feat(table): enforce line alignment in table render
* test(table): add table alignment render test
(widgets::table) Add option to always allocate the "selection" constraint (#375) (f63ac72)
* feat(table): add option to configure selection layout changes
Before this option was available, selecting a row in the table when no row was selected
previously made the tables layout change (the same applies to unselecting) by adding the width
of the "highlight symbol" in the front of the first column, this option allows to configure this
behavior.
* refactor(table): refactor "get_columns_widths" to return (x, width)
and "render" to make use of that
* refactor(table): refactor "get_columns_widths" to take in a selection_width instead of a boolean
also refactor "render" to make use of this change
* fix(table): rename "highlight_set_selection_space" to "highlight_spacing"
* style(table): apply doc-comment suggestions from code review
(uncategorized) Expand serde attributes for TestBuffer (#389)
(57ea871)
(uncategorized) Add weak constraints to make rects closer to each other in size ✨ (#395) (6153371)
Also make `Max` and `Min` constraints MEDIUM strength for higher priority over equal chunks
(barchart) Empty groups causes panic (#333) (9c95673)
This unlikely to happen, since nobody wants to add an empty group.
Even we fix the panic, things will not render correctly.
So it is better to just not add them to the BarChart.
(block) Fixed title_style not rendered (#349) (#363) (49a82e0)
(cargo) Adjust minimum paste version (#348) (8db9fb4)
ratatui is using features that are currently only available in paste 1.0.2; specifying the minimum version to be 1.0 will consequently cause a compilation error if cargo is only able to use a version less than 1.0.2.
(example) Fix typo (#337) (daf5890)
the existential feels
(layout) Don't leave gaps between chunks (#408) (56455e0)
Previously the layout used the floor of the calculated start and width
as the value to use for the split Rects. This resulted in gaps between
the split rects.
This change modifies the layout to round to the nearest column instead
of taking the floor of the start and width. This results in the start
and end of each rect being rounded the same way and being strictly
adjacent without gaps.
Because there is a required constraint that ensures that the last end is
equal to the area end, there is no longer the need to fixup the last
item width when the fill (as e.g. width = x.99 now rounds to x+1 not x).
The colors example has been updated to use Ratio(1, 8) instead of
Percentage(13), as this now renders without gaps for all possible sizes,
whereas previously it would have left odd gaps between columns.
(layout) Ensure left <= right (#410) (f4ed3b7)
The recent refactor missed the positive width constraint
(release) Fix the last tag retrieval for alpha releases (#416) (b6b2da5)
(release) Set the correct permissions for creating alpha releases (#400) (778c320)
(scrollbar) Move symbols to symbols module (#330) (7539f77) [breaking]
The symbols and sets are moved from `widgets::scrollbar` to
`symbols::scrollbar`. This makes it consistent with the other symbol
sets and allows us to make the scrollbar module private rather than
re-exporting it.
(table) Fix unit tests broken due to rounding (#419) (dc55211)
The merge of the table unit tests after the rounding layout fix was not
rebased correctly, this addresses the broken tests, makes them more
concise while adding comments to help clarify that the rounding behavior
is working as expected.
(uncategorized) Correct minor typos in documentation (#331) (13fb11a)
(barchart) Reduce some calculations (#430) (fc727df)
Calculating the label_offset is unnecessary, if we just render the
group label after rendering the bars. We can just reuse bar_y.
(layout) Simplify and doc split() (#405) (de25de0)
* test(layout): add tests for split()
* refactor(layout): simplify and doc split()
This is mainly a reduction in density of the code with a goal of
improving mainatainability so that the algorithm is clear.
(layout) Simplify split() function (#396) (5195099)
Removes some unnecessary code and makes the function more readable.
Instead of creating a temporary result and mutating it, we just create
the result directly from the list of changes.
(examples) Fix the instructions for generating demo GIF (#442) (7a70602)
(examples) Show layout constraints (#393) (10dbd6f)
Shows the way that layout constraints interact visually

(examples) Add color and modifiers examples (#345) (6ad4bd4)
The intent of these examples is to show the available colors and
modifiers.
- added impl Display for Color


(examples) Update block example (#351) (554805d)

(examples) Add examples readme with gifs (#303) (add578a)
This commit adds a readme to the examples directory with gifs of each
example. This should make it easier to see what each example does
without having to run it.
I modified the examples to fit better in the gifs. Mostly this was just
removing the margins, but for the block example I cleaned up the code a
bit to make it more readable and changed it so the background bug is not
triggered.
For the table example, the combination of Min, Length, and Percent
constraints was causing the table to panic when the terminal was too
small. I changed the example to use the Max constraint instead of the
Length constraint.
The layout example now shows information about how the layout is
constrained on each block (which is now a paragraph with a block).
(layout::Constraint) Add doc-comments for all variants (#371) (c8ddc16)
(lib) Extract feature documentation from Cargo.toml (#438) (8b36683)
* docs(lib): extract feature documentation from Cargo.toml
* chore(deps): make `document-features` optional dependency
* docs(lib): document the serde feature from features section
(project) Make the project description cooler (#441) (47fe4ad)
* docs(project): make the project description cooler
* docs(lib): simplify description
(readme) Fix widget docs links (#346) (2920e04)
Add scrollbar, clear. Fix Block link. Sort
(uncategorized) Improve scrollbar doc comment (#329) (c3f87f2)
(bench) Used iter_batched to clone widgets in setup function (#383)
(149d489)
Replaced `Bencher::iter` by `Bencher::iter_batched` to clone the widget in the setup function instead of in the benchmark timing.
(paragraph) Add documentation for "scroll"'s "offset" (#355) (ab5e616)
* style(paragraph): add documentation for "scroll"'s "offset"
* style(paragraph): add more text to the scroll doc-comment
(block) Add benchmarks (#368) (e18393d)
Added benchmarks to the block widget to uncover eventual performance issues
(canvas) Add unit tests for line (#437) (ad3413e)
Also add constructor to simplify creating lines
(list) Added benchmarks (#377) (664fb4c)
Added benchmarks for the list widget (render and render half scrolled)
(sparkline) Added benchmark (#384) (3293c6b)
Added benchmark for the `sparkline` widget testing a basic render with different amount of data
(styled_grapheme) Test StyledGrapheme methods (#433) (292a11d)
(table) Add test for consistent table-column-width (#404) (4cd843e)
(test_backend) Add tests for TestBackend coverage (#434) (b35f19e)
These are mostly to catch any future bugs introduced in the test backend
(changelog) Show full commit message (#423) (a937500)
This allows someone reading the changelog to search for information
about breaking changes or implementation of new functionality.
- refactored the commit template part to a macro instead of repeating it
- added a link to the commit and to the release
- updated the current changelog for the alpha and unreleased changes
- Automatically changed the existing * lists to - lists
(codecov) Fix yaml syntax (#407) (ea48af1)
a yaml file cannot contain tabs outside of strings
(docs) Add doc comment bump to release documentation (#382) (8b28672)
(github) Rename tui-rs-revival references to ratatui-org (#340)
(964190a)
(make) Add task descriptions to Makefile.toml (#398) (268bbed)
(toolchain) Bump msrv to 1.67 (#361) (8cd3205) [breaking]
* chore(toolchain)!: bump msrv to 1.67
(traits) Add Display and FromStr traits (#425) (98155dc)
Use strum for most of these, with a couple of manual implementations,
and related tests
(uncategorized) Use vhs to create demo.gif (#390) (8c55158)
The bug that prevented braille rendering is fixed, so switch to VHS for
rendering the demo gif

(uncategorized) Implement Hash common traits (#381)
(8c4a2e0)
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
Hash trait won't be impl in this PR due to rust std design.
If we need hash trait for f64 related structs in the future,
we should consider wrap f64 into a new type.
(uncategorized) Implement Eq & PartialEq common traits (#357)
(181706c)
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
(uncategorized) Implement Clone & Copy common traits (#350)
(440f62f)
Implement `Clone & Copy` common traits for most structs in src.
Only implement `Copy` for structs that are simple and trivial to copy.
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
(uncategorized) Implement Debug & Default common traits (#339)
(bf49446)
Implement `Debug & Default` common traits for most structs in src.
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
(examples) Fix cargo make run-examples (#327) (e2cb11c)
Enables the all-widgets feature so that the calendar example runs correctly
(uncategorized) Forbid unsafe code (#332) (0fb1ed8)
This indicates good (high level) code and is used by tools like cargo-geiger.
(coverage) Exclude examples directory from coverage (#373) (de9f52f)
(uncategorized) Don't fail fast (#364) (9191ad6)
Run all the tests rather than canceling when one test fails. This allows
us to see all the failures, rather than just the first one if there are
multiple. Specifically this is useful when we have an issue in one
toolchain or backend.
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!
Special thanks to Florian Dehau for creating this awesome library 💖 We don't see how this would be possible without him in the first place.
Nothing published for this version
*(list)* Add option to always allocate the "selection" column width
(list) Add option to always allocate the "selection" column width (#394) (4d70169)
* feat(list): add option to always allocate the "selection" column width
Before this option was available, selecting a item in a list when nothing was selected
previously made the row layout change (the same applies to unselecting) by adding the width
of the "highlight symbol" in the front of the list, this option allows to configure this
behavior.
* style: change "highlight_spacing" doc comment to use inline code-block for reference
(table) Add support for line alignment in the table widget (#392) (7748720)
* feat(table): enforce line alignment in table render
* test(table): add table alignment render test
(layout) Don't leave gaps between chunks (#408) (56455e0)
Previously the layout used the floor of the calculated start and width
as the value to use for the split Rects. This resulted in gaps between
the split rects.
This change modifies the layout to round to the nearest column instead
of taking the floor of the start and width. This results in the start
and end of each rect being rounded the same way and being strictly
adjacent without gaps.
Because there is a required constraint that ensures that the last end is
equal to the area end, there is no longer the need to fixup the last
item width when the fill (as e.g. width = x.99 now rounds to x+1 not x).
The colors example has been updated to use Ratio(1, 8) instead of
Percentage(13), as this now renders without gaps for all possible sizes,
whereas previously it would have left odd gaps between columns.
(layout) Ensure left <= right (#410) (f4ed3b7)
The recent refactor missed the positive width constraint
(release) Fix the last tag retrieval for alpha releases (#416) (b6b2da5)
(layout) Simplify and doc split() (#405) (de25de0)
* test(layout): add tests for split()
* refactor(layout): simplify and doc split()
This is mainly a reduction in density of the code with a goal of
improving mainatainability so that the algorithm is clear.
(layout) Simplify split() function (#396) (5195099)
Removes some unnecessary code and makes the function more readable.
Instead of creating a temporary result and mutating it, we just create
the result directly from the list of changes.
(examples) Show layout constraints (#393) (10dbd6f)
Shows the way that layout constraints interact visually

(codecov) Fix yaml syntax (#407) (ea48af1)
a yaml file cannot contain tabs outside of strings
(uncategorized) Use vhs to create demo.gif (#390) (8c55158)
The bug that prevented braille rendering is fixed, so switch to VHS for
rendering the demo gif

<!-- generated by git-cliff -->
*(release)* Add automated nightly releases
(release) Add automated nightly releases (#359) (aad164a)
* feat(release): add automated nightly releases
* refactor(release): rename the alpha workflow
* refactor(release): simplify the release calculation
(scrollbar) Add optional track symbol (#360) (1727fa5) [breaking]
The track symbol is now optional, simplifying composition with other
widgets.
(widgets::table) Add option to always allocate the "selection" constraint (#375) (f63ac72)
* feat(table): add option to configure selection layout changes
Before this option was available, selecting a row in the table when no row was selected
previously made the tables layout change (the same applies to unselecting) by adding the width
of the "highlight symbol" in the front of the first column, this option allows to configure this
behavior.
* refactor(table): refactor "get_columns_widths" to return (x, width)
and "render" to make use of that
* refactor(table): refactor "get_columns_widths" to take in a selection_width instead of a boolean
also refactor "render" to make use of this change
* fix(table): rename "highlight_set_selection_space" to "highlight_spacing"
* style(table): apply doc-comment suggestions from code review
(barchart) Empty groups causes panic (#333) (9c95673)
This unlikely to happen, since nobody wants to add an empty group.
Even we fix the panic, things will not render correctly.
So it is better to just not add them to the BarChart.
(block) Fixed title_style not rendered (#349) (#363) (49a82e0)
(cargo) Adjust minimum paste version (#348) (8db9fb4)
ratatui is using features that are currently only available in paste 1.0.2; specifying the minimum version to be 1.0 will consequently cause a compilation error if cargo is only able to use a version less than 1.0.2.
(example) Fix typo (#337) (daf5890)
the existential feels
(release) Set the correct permissions for creating alpha releases (#400) (778c320)
(scrollbar) Move symbols to symbols module (#330) (7539f77) [breaking]
The symbols and sets are moved from `widgets::scrollbar` to
`symbols::scrollbar`. This makes it consistent with the other symbol
sets and allows us to make the scrollbar module private rather than
re-exporting it.
(uncategorized) Correct minor typos in documentation (#331) (13fb11a)
(examples) Add color and modifiers examples (#345) (6ad4bd4)
The intent of these examples is to show the available colors and
modifiers.
- added impl Display for Color


(examples) Update block example (#351) (554805d)

(examples) Add examples readme with gifs (#303) (add578a)
This commit adds a readme to the examples directory with gifs of each
example. This should make it easier to see what each example does
without having to run it.
I modified the examples to fit better in the gifs. Mostly this was just
removing the margins, but for the block example I cleaned up the code a
bit to make it more readable and changed it so the background bug is not
triggered.
For the table example, the combination of Min, Length, and Percent
constraints was causing the table to panic when the terminal was too
small. I changed the example to use the Max constraint instead of the
Length constraint.
The layout example now shows information about how the layout is
constrained on each block (which is now a paragraph with a block).
(layout::Constraint) Add doc-comments for all variants (#371) (c8ddc16)
(readme) Fix widget docs links (#346) (2920e04)
Add scrollbar, clear. Fix Block link. Sort
(uncategorized) Improve scrollbar doc comment (#329) (c3f87f2)
(bench) Used iter_batched to clone widgets in setup function (#383)
(149d489)
Replaced `Bencher::iter` by `Bencher::iter_batched` to clone the widget in the setup function instead of in the benchmark timing.
(block) Add benchmarks (#368) (e18393d)
Added benchmarks to the block widget to uncover eventual performance issues
(list) Added benchmarks (#377) (664fb4c)
Added benchmarks for the list widget (render and render half scrolled)
(sparkline) Added benchmark (#384) (3293c6b)
Added benchmark for the `sparkline` widget testing a basic render with different amout of data
(docs) Add doc comment bump to release documentation (#382) (8b28672)
(github) Rename tui-rs-revival references to ratatui-org (#340)
(964190a)
(make) Add task descriptions to Makefile.toml (#398) (268bbed)
(toolchain) Bump msrv to 1.67 (#361) (8cd3205) [breaking]
* chore(toolchain)!: bump msrv to 1.67
(uncategorized) Implement Hash common traits (#381)
(8c4a2e0)
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
Hash trait won't be impl in this PR due to rust std design.
If we need hash trait for f64 related structs in the future,
we should consider wrap f64 into a new type.
(uncategorized) Implement Eq & PartialEq common traits (#357)
(181706c)
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
(examples) Fix cargo make run-examples (#327) (e2cb11c)
Enables the all-widgets feature so that the calendar example runs correctly
(uncategorized) Forbid unsafe code (#332) (0fb1ed8)
This indicates good (high level) code and is used by tools like cargo-geiger.
(coverage) Exclude examples directory from coverage (#373) (de9f52f)
(uncategorized) Don't fail fast (#364) (9191ad6)
Run all the tests rather than canceling when one test fails. This allows
us to see all the failures, rather than just the first one if there are
multiple. Specifically this is useful when we have an issue in one
toolchain or backend.
(uncategorized) Implement Clone & Copy common traits (#350)
(440f62f)
Implement `Clone & Copy` common traits for most structs in src.
Only implement `Copy` for structs that are simple and trivial to copy.
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
(uncategorized) Implement Debug & Default common traits (#339)
(bf49446)
Implement `Debug & Default` common traits for most structs in src.
Reorder the derive fields to be more consistent:
Debug, Default, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash
Nothing published for this version
We are happy to release the new version of ratatui 🐭, a community-maintained fork of tui.
We are happy to release the new version of ratatui 🐭, a community-maintained fork of tui.
In this version, we have introduced a new Scrollbar widget and enhanced the functionality of existing widgets like Block and Barchart. We have also made significant improvements to the stylization/widgets API, ensuring a smoother experience when creating TUIs. Additionally, we have addressed various bugs and implemented enhancements to optimize the overall user experience in TUI development.
Here is a blog post highlighting the prominent new features and providing practical examples of their usage: https://blog.orhun.dev/ratatui-0-22-0
tui-term a pseudoterminal library (#268)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!
Special thanks to Florian Dehau for creating this awesome library 💖 We don't see how this would be possible without him in the first place.
Feel free to join our Discord for more discussion!
This marks the next big release of ratatui, a community-maintained fork of tui.
This marks the next big release of ratatui, a community-maintained fork of tui.
A bunch of new features are added and we also worked on improving the current widgets for better functionality and usability. We are also happy to share that most of the pending pull-requests from tui-rs are now reviewed and merged!
Here is a blog post outlining the new features that stand out and giving usage examples: https://blog.orhun.dev/ratatui-0-21-0
FromStr implementation for Color (#180)Masked to display secure data (#168) [breaking]vec![] in user_input example (#26)Spans with Line (#178)assert_buffer_eq! and Debug implementation (#161)Thank you so much to everyone that contributed to this release!
Here is the list of contributors who has contributed to ratatui for the first time!
Big thanks to @joshka for his great efforts on development and maintenance for this release.
And once again, special thanks to Florian Dehau for creating this awesome library 💖 We don't see how this would be possible without him in the first place.
Feel free to join our Discord for more discussion!
This is a bug fix release for the bold text style which wasn't displaying correctly.
This is a bug fix release for the bold text style which wasn't displaying correctly.
Thank you so much to everyone that contributed to this release!
*(ci)* Fix deprecation warnings on CI
This marks the first release of ratatui, a community-maintained fork of tui.
The purpose of this release is to include bug fixes and small changes into the repository thus no new big features are added. We have transferred all the pull requests from the original repository and worked on the low hanging ones to incorporate them in this "maintenance" release.
Here is a list of changes:
offset() to TableState (#10)width() to ListItem (#17)Paragraphtypos for checking typos (#91)committed for checking conventional commits (#77)rust-version to 1.59 in Cargo.toml (#57)tuiThank you so much to everyone that contributed to this release!
And most importantly, special thanks to Florian Dehau for creating this awesome library 💖 We look forward to building on the strong foundations that the original crate laid out.
Nothing published for this version
One column per quarter.