From 85939306e3fef04322483954d3031399a58d002b Mon Sep 17 00:00:00 2001 From: Florian Dehau Date: Sat, 22 Jan 2022 12:30:50 +0100 Subject: [PATCH] Release v0.17.0 --- CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ Cargo.toml | 4 ++-- README.md | 24 ++++++++++++------------ src/lib.rs | 5 +++-- 4 files changed, 54 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8768b37..0305635 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,46 @@ ## To be released +## v0.17.0 - 2022-01-22 + ### 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 the `Chart` widget (#568). + +### Breaking changes + +* The minimum supported rust version is now `1.56.1`. + +#### New default backend and consolidated backend options (#553) + +* `crossterm` is now the default backend. +If you are already using the `crossterm` backend, you can simplify your dependency specification in `Cargo.toml`: +```diff +- tui = { version = "0.16", default-features = false, features = ["crossterm"] } ++ tui = "0.17" +``` +If you are using the `termion` backend, your `Cargo` 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 version `0.22`. + +Because of their apparent low usage, `curses` and `rustbox` backends have been removed. +If you are using one of them, you can import their last implementation in your own project: +* [curses](https://github.com/fdehau/tui-rs/blob/v0.16.0/src/backend/curses.rs) +* [rustbox](https://github.com/fdehau/tui-rs/blob/v0.16.0/src/backend/rustbox.rs) + +#### Canvas labels (#543) + +* Labels of the `Canvas` widget are now `text::Spans`. +The signature of `widgets::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))) +``` ## v0.16.0 - 2021-08-01 diff --git a/Cargo.toml b/Cargo.toml index cb2bd34..c4a847f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,11 @@ [package] name = "tui" -version = "0.16.0" +version = "0.17.0" authors = ["Florian Dehau "] description = """ A library to build rich terminal user interfaces or dashboards """ -documentation = "https://docs.rs/tui/0.16.0/tui/" +documentation = "https://docs.rs/tui/0.17.0/tui/" keywords = ["tui", "terminal", "dashboard"] repository = "https://github.com/fdehau/tui-rs" readme = "README.md" diff --git a/README.md b/README.md index a906db0..fb2be0d 100644 --- a/README.md +++ b/README.md @@ -45,8 +45,8 @@ cargo run --example demo --no-default-features --features=termion --release -- - where `tick-rate` is the UI refresh rate in ms. -The UI code is in [examples/demo/ui.rs](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/demo/ui.rs) while the -application state is in [examples/demo/app.rs](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/demo/app.rs). +The UI code is in [examples/demo/ui.rs](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/demo/ui.rs) while the +application state is in [examples/demo/app.rs](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/demo/app.rs). If the user interface contains glyphs that are not displayed correctly by your terminal, you may want to run the demo without those symbols: @@ -59,16 +59,16 @@ cargo run --example demo --release -- --tick-rate 200 --enhanced-graphics false The library comes with the following list of widgets: - * [Block](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/block.rs) - * [Gauge](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/gauge.rs) - * [Sparkline](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/sparkline.rs) - * [Chart](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/chart.rs) - * [BarChart](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/barchart.rs) - * [List](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/list.rs) - * [Table](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/table.rs) - * [Paragraph](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/paragraph.rs) - * [Canvas (with line, point cloud, map)](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/canvas.rs) - * [Tabs](https://github.com/fdehau/tui-rs/blob/v0.16.0/examples/tabs.rs) + * [Block](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/block.rs) + * [Gauge](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/gauge.rs) + * [Sparkline](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/sparkline.rs) + * [Chart](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/chart.rs) + * [BarChart](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/barchart.rs) + * [List](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/list.rs) + * [Table](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/table.rs) + * [Paragraph](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/paragraph.rs) + * [Canvas (with line, point cloud, map)](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/canvas.rs) + * [Tabs](https://github.com/fdehau/tui-rs/blob/v0.17.0/examples/tabs.rs) Click on each item to see the source of the example. Run the examples with with cargo (e.g. to run the gauge example `cargo run --example gauge`), and quit by pressing `q`. diff --git a/src/lib.rs b/src/lib.rs index 1439350..b9d140a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,7 +9,7 @@ //! //! ```toml //! [dependencies] -//! tui = "0.16" +//! tui = "0.17" //! crossterm = "0.22" //! ``` //! @@ -20,7 +20,8 @@ //! ```toml //! [dependencies] //! termion = "1.5" -//! tui = { version = "0.16", default-features = false, features = ['termion'] } +//! tui = { version = "0.17", default-features = false, features = ['termion'] } +//! //! ``` //! //! The same logic applies for all other available backends.