Changelog History
Page 1
-
v0.19.0 Changes
August 14, 2022π Features
- β¬οΈ Bump
crossterm
to0.25
- β¬οΈ Bump
-
v0.18.0 Changes
April 24, 2022π Features
- β‘οΈ Update
crossterm
to0.23
- β‘οΈ Update
-
v0.17.0 Changes
January 22, 2022π Features
- β Add option to
widgets::List
to repeat the hightlight symbol for each line of multi-line items (#533). - β Add option to control the alignment of
Axis
labels in theChart
widget (#568).
π₯ Breaking changes
- π The minimum supported rust version is now
1.56.1
.
π New default backend and consolidated backend options (#553)
- 0οΈβ£
crossterm
is now the default backend. If you are already using thecrossterm
backend, you can simplify your dependency specification inCargo.toml
:diff - tui = { version = "0.16", default-features = false, features = ["crossterm"] } + tui = "0.17"
If you are using thetermion
backend, yourCargo
is now a bit more verbose:diff - tui = "0.16" + tui = { version = "0.17", default-features = false, features = ["termion"] }
crossterm
has also been bumped to version0.22
.π Because of their apparent low usage,
curses
andrustbox
backends have been removed. If you are using one of them, you can import their last implementation in your own project:Canvas labels (#543)
- Labels of the
Canvas
widget are nowtext::Spans
. β‘οΈ The signature ofwidgets::canvas::Context::print
has thus been updated:diff - ctx.print(x, y, "Some text", Color::Yellow); + ctx.print(x, y, Span::styled("Some text", Style::default().fg(Color::Yellow)))
- β Add option to
-
v0.16.0 Changes
August 01, 2021π Features
- β‘οΈ Update
crossterm
to0.20
. - β Add
From<Cow<str>>
implementation fortext::Text
(#471). - β Add option to right or center align the title of a
widgets::Block
(#462).
π Fixes
- π
Apply label style in
widgets::Gauge
and avoid panics because of overflows with long labels (#494). - Avoid panics because of overflows with long axis labels in
widgets::Chart
(#512). - π Fix computation of column widths in
widgets::Table
(#514). - π Fix panics because of invalid offset when input changes between two frames in
widgets::List
andwidgets::Chart
(#516).
- β‘οΈ Update
-
v0.15.0 Changes
May 02, 2021π Features
- β‘οΈ Update
crossterm
to0.19
. - β‘οΈ Update
rand
to0.8
. - β Add a read-only view of the terminal state after the draw call (#440).
π Fixes
- β Remove compile warning in
TestBackend::assert_buffer
(#466).
- β‘οΈ Update
-
v0.14.0 Changes
January 01, 2021π₯ Breaking changes
π New API for the Table widget
The
Table
widget got a lot of improvements that should make it easier to work with:- It should not longer panic when rendered on small areas.
- π
Row
s are now a collection ofCell
s, themselves wrapping aText
. This means you can style the entireTable
, an entireRow
, an entireCell
and rely on the styling capabilities ofText
to get full control over the look of yourTable
. Row
s can have multiple lines.- The header is now optional and is just another
Row
always visible at the top. Row
s can have a bottom margin.- The header alignment is no longer off when an item is selected.
π» Taking the example of the code in
examples/demo/ui.rs
, this is what you may have to change:let failure_style = Style::default() .fg(Color::Red) .add_modifier(Modifier::RAPID_BLINK | Modifier::CROSSED_OUT); - let header = ["Server", "Location", "Status"]; let rows = app.servers.iter().map(|s| { let style = if s.status == "Up" { up_style } else { failure_style }; - Row::StyledData(vec![s.name, s.location, s.status].into_iter(), style) + Row::new(vec![s.name, s.location, s.status]).style(style) }); - let table = Table::new(header.iter(), rows) + let table = Table::new(rows) + .header( + Row::new(vec!["Server", "Location", "Status"]) + .style(Style::default().fg(Color::Yellow)) + .bottom_margin(1), + ) .block(Block::default().title("Servers").borders(Borders::ALL)) - .header_style(Style::default().fg(Color::Yellow)) .widths(&[ Constraint::Length(15), Constraint::Length(15),
Here, we had to:
- π Change the way we construct
Row
which is no longer anenum
but astruct
. It accepts anything that can be converted to an iterator of things π that can be converted to aCell
- The header is no longer a required parameter so we use
π
Table::header
to set it. πTable::header_style
has been removed since the style can be directly set using πRow::style
. In addition, we want to preserve the old margin between the header and the rest of the rows so we add a bottom margin to the header using πRow::bottom_margin
.
π You may want to look at the documentation of the different types to get a better understanding:
π Fixes
- π Fix handling of Non Breaking Space (NBSP) in wrapped text in
Paragraph
widget.
π Features
- β Add
Style::reset
to create aStyle
resetting all styling properties when applied. - β Add an option to render the
Gauge
widget with unicode blocks. - Manage common project tasks with
cargo-make
rather thanmake
for easier on-boarding.
-
v0.13.0 Changes
November 14, 2020π Features
- β Add
LineGauge
widget which is a more compact variant of the existingGauge
. - β¬οΈ Bump
crossterm
to 0.18
π Fixes
- Take into account the borders of the
Table
widget when the widths of columns is controlled by
Percentage
andRatio
constraints.
- β Add
-
v0.12.0 Changes
September 27, 2020 -
v0.11.0 Changes
September 20, 2020Β Features
- β Add the dot character as a new type of canvas marker (#350).
- π Support more style modifiers on Windows (#368).
π Fixes
- π» Clearing the terminal through
Terminal::clear
will cause the whole UI to be redrawn (#380). - π Fix incorrect output when the first diff to draw is on the second cell of the terminal (#347).
-
v0.10.0 Changes
July 17, 2020π₯ Breaking changes
Easier cursor management
A new method has been added to
Frame
calledset_cursor
. It lets you specify where the cursor should be placed after the draw call. Furthermore like any other widgets, if you do not set a cursor position during a draw call, the cursor is automatically hidden.For example:
fn draw_input(f: &mut Frame, app: &App) { if app.editing { let input_width = app.input.width() as u16; // The cursor will be placed just after the last character of the input f.set_cursor((input_width + 1, 0)); } else { // We are no longer editing, the cursor does not have to be shown, set_cursor is not called and // thus automatically hidden. } }
In order to make this possible, the draw closure takes in input
&mut Frame
instead ofmut Frame
.Advanced text styling
It has been reported several times that the text styling capabilities were somewhat limited in many π places of the crate. To solve the issue, this release includes a new set of text primitives that are now used by a majority of widgets to provide flexible text styling.
Text
is replaced by the following types:- π
Span
: a string with a unique style. - π
Spans
: a string with multiple styles. - π
Text
: a multi-lines string with multiple styles.
However, you do not always need this complexity so the crate provides
From
implementations to 0οΈβ£ let you use simple strings as a default and switch to the previous primitives when you need β additional styling capabilities.For example, the title of a
Block
can be set in the following ways:// A title with no styling Block::default().title("My title"); // A yellow title Block::default().title(Span::styled("My title", Style::default().fg(Color::Yellow))); // A title where "My" is bold and "title" is a simple string Block::default().title(vec![ Span::styled("My", Style::default().add_modifier(Modifier::BOLD)), Span::from("title") ]);
Buffer::set_spans
andBuffer::set_span
were added.Paragraph::new
expects an input that can be converted to aText
.- π
Block::title_style
is deprecated. Block::title
expects aSpans
.Tabs
expects a list ofSpans
.Gauge
custom label is now aSpan
.Axis
title and labels areSpans
(as a consequenceChart
no longer has generic bounds).
Incremental styling
π Previously
Style
was used to represent an exhaustive set of style rules to be applied to an UI element. It implied that whenever you wanted to change even only one property you had to provide the π complete style. For example, if you had aBlock
where you wanted to have a green background and a title in bold, you had to do the following:let style = Style::default().bg(Color::Green); Block::default() .style(style) .title("My title") // Here we reused the style otherwise the background color would have been reset .title_style(style.modifier(Modifier::BOLD));
π In this new release, you may now write this as:
Block::default() .style(Style::default().bg(Color::Green)) // The style is not overidden anymore, we simply add new style rule for the title. .title(Span::styled("My title", Style::default().add_modifier(Modifier::BOLD)))
π In addition, the crate now provides a method
patch
to combine two styles into a new set of style rules:let style = Style::default().modifer(Modifier::BOLD); let style = style.patch(Style::default().add_modifier(Modifier::ITALIC)); // style.modifer == Modifier::BOLD | Modifier::ITALIC, the modifier has been enriched not overidden
- π
Style::modifier
has been removed in favor ofStyle::add_modifier
andStyle::remove_modifier
. - π
Buffer::set_style
has been added.Buffer::set_background
is deprecated. - π
BarChart::style
no longer set the style of the bars. UseBarChart::bar_style
in replacement. - π
Gauge::style
no longer set the style of the gauge. UseGauge::gauge_style
in replacement.
List with item on multiple lines
π¨ The
List
widget has been refactored once again to support items with variable heights and complex styling.List::new
expects an input that can be converted to aVec<ListItem>
whereListItem
is a wrapper around the item content to provide additional styling capabilities.ListItem
contains aText
.- π
List::items
has been removed.
// Before let items = vec![ "Item1", "Item2", "Item3" ]; List::default().items(items.iters()); // After let items = vec![ ListItem::new("Item1"), ListItem::new("Item2"), ListItem::new("Item3"), ]; List::new(items);
π See the examples for more advanced usages.
More wrapping options
Paragraph::wrap
expectsWrap
instead ofbool
to let users decided whether they want to trim whitespaces when the text is wrapped.// before Paragraph::new(text).wrap(true) // after Paragraph::new(text).wrap(Wrap { trim: true }) // to have the same behavior Paragraph::new(text).wrap(Wrap { trim: false }) // to use the new behavior
Horizontal scrolling in paragraph
You can now scroll horizontally in
Paragraph
. The argument ofParagraph::scroll
has thus be π changed fromu16
to(u16, u16)
.π Features
π Serialization of style
π You can now serialize and de-serialize
Style
using the optionalserde
feature. - π