From 80e1db129a8801c4ddcd08a98d33682f477e0a42 Mon Sep 17 00:00:00 2001 From: rhysd Date: Wed, 25 Oct 2023 00:10:56 +0900 Subject: [PATCH] update changelog for v0.3.0 changes --- CHANGELOG.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1be49c5..e35e67b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,50 @@ + +# [v0.3.0](https://github.com/rhysd/tui-textarea/releases/tag/v0.3.0) - 24 Oct 2023 + +- **BREAKING CHANGE:** Enable ratatui support by default instead of inactive tui-rs. + - `ratatui-` prefix is removed from all `ratatui-*` features. `crossterm`, `termion`, and `termwiz` features are for ratatui: + ```yaml + # ratatui with crossterm backend + tui-textarea = "0.3" + # ratatui with termwiz backend + tui-textarea = { version = "0.3", features = ["termwiz"], default-features = false } + # ratatui with termion backend + tui-textarea = { version = "0.3", features = ["termion"], default-features = false } + ``` + - Instead, features for tui-rs support are now prefixed with `tuirs-`: + ```yaml + # tui-rs with crossterm backend + tui-textarea = { version = "0.3", features = ["tuirs-crossterm"], default-features = false } + # Use proper version of crossterm + crossterm = "0.2.5" + ``` + - Examples and documents are now implemented and described with ratatui by default +- **BREAKING CHANGE:** Rename `your-backend` features to `no-backend`. You need to update the feature names if you're using tui-textarea with your own backend. +- Relax the restriction of ratatui crate dependency from `0.23.0` to `>=0.23.0, <1`, which means 'v0.23.0 or later and earlier than v1'. The latest version of ratatui (v0.24.0) now works with tui-textarea ([#36](https://github.com/rhysd/tui-textarea/issues/36)). +- Enable `termwiz` and `termion` features on generating the API document. APIs to convert from input events of termwiz/termion to [`tui_textarea::Input`](https://docs.rs/tui-textarea/latest/tui_textarea/struct.Input.html) are now listed in the document. + +Previous Backend features table (v0.2.4): + +| | crossterm | termion | termwiz | Your own backend | +|---------|----------------------------------|-------------------|-------------------|------------------------| +| tui-rs | `crossterm` (enabled by default) | `termion` | N/A | `your-backend` | +| ratatui | `ratatui-crossterm` | `ratatui-termion` | `ratatui-termwiz` | `ratatui-your-backend` | + +New backend features table (v0.3.0): + +| | crossterm | termion | termwiz | Your own backend | +|---------|----------------------------------|-----------------|-----------|--------------------| +| tui-rs | `tuirs-crossterm` | `tuirs-termion` | N/A | `tuirs-no-backend` | +| ratatui | `crossterm` (enabled by default) | `termion` | `termwiz` | `no-backend` | + + +[Changes][v0.3.0] + + # [v0.2.4](https://github.com/rhysd/tui-textarea/releases/tag/v0.2.4) - 21 Oct 2023 -- Support the [termwiz](https://crates.io/crates/termwiz) backend for ratatui. `ratatui-termwiz` feature was newly added for this. +- Support the ratatui's [termwiz](https://crates.io/crates/termwiz) backend. `ratatui-termwiz` feature was newly added for this. - Add the following dependencies in your Cargo.toml to use termwiz support. ```toml termwiz = "0.20" @@ -203,6 +246,7 @@ First release :tada: [Changes][v0.1.0] +[v0.3.0]: https://github.com/rhysd/tui-textarea/compare/v0.2.4...v0.3.0 [v0.2.4]: https://github.com/rhysd/tui-textarea/compare/v0.2.3...v0.2.4 [v0.2.3]: https://github.com/rhysd/tui-textarea/compare/v0.2.2...v0.2.3 [v0.2.2]: https://github.com/rhysd/tui-textarea/compare/v0.2.1...v0.2.2