From 43286092c6072a94733eb3b7f6e0bfc944cbcd73 Mon Sep 17 00:00:00 2001 From: rhysd Date: Mon, 2 Oct 2023 02:09:41 +0900 Subject: [PATCH] update changelog for v0.2.1 changes --- CHANGELOG.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2e23b8..b8f81a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,31 @@ + +# [v0.2.1](https://github.com/rhysd/tui-textarea/releases/tag/v0.2.1) - 01 Oct 2023 + +- [ratatui](https://crates.io/crates/ratatui) crate is supported in addition to [tui-rs](https://crates.io/crates/tui). The ratatui crate is a community fork of inactive tui-rs crate. ([#12](https://github.com/rhysd/tui-textarea/issues/12)) + - The latest version of ratatui v0.23 is supported. + - tui-textarea still uses tui-rs by default to keep the compatibility at this moment. ratatui users explicitly need to set features for it. See [the installation document](https://github.com/rhysd/tui-textarea#installation) for the features matrix. For example, when you want to use ratatui and crossterm, write the following in your `Cargo.toml`: + ```toml + [dependencies] + ratatui = "*" + tui-textarea = { version = "*", features = ["ratatui-crossterm"], default-features = false } + ``` + - tui-rs is no longer maintained and the repository was archived. At the next minor version bump, tui-textarea will switch the default features from tui-rs to ratatui. If you use tui-rs, I recommend to switch your dependency to ratatui and to prepare for the version bump. + - Examples with ratatui are added to [the `examples` directory](https://github.com/rhysd/tui-textarea/tree/main/examples). For example, the following command runs ratatui version of `editor` example: + ```sh + cargo run --example ratatui_editor --no-default-features --features=ratatui-crossterm,search file.txt + ``` +- Add support for the placeholder text which is rendered when no text is input in the textarea. ([#16](https://github.com/rhysd/tui-textarea/issues/16), thanks [@pm100](https://github.com/pm100)) + - Use `TextArea::set_placeholder_text` to set the text. To change the text style, use `TextArea::set_placeholder_style`. See [the documentation](https://docs.rs/crate/tui-textarea/latest) for more details. + - `popup_placeholder` example was added to show the usage. + ```sh + cargo run --example popup_placeholder + ``` +- Derive `Debug` trait for `TextArea` struct. ([#23](https://github.com/rhysd/tui-textarea/issues/23)) +- Fix a key input is received twice on Windows. ([#17](https://github.com/rhysd/tui-textarea/issues/17), thanks [@pm100](https://github.com/pm100)) + +[Changes][v0.2.1] + + # [v0.2.0](https://github.com/rhysd/tui-textarea/releases/tag/v0.2.0) - 18 Oct 2022 @@ -136,6 +164,7 @@ First release :tada: [Changes][v0.1.0] +[v0.2.1]: https://github.com/rhysd/tui-textarea/compare/v0.2.0...v0.2.1 [v0.2.0]: https://github.com/rhysd/tui-textarea/compare/v0.1.6...v0.2.0 [v0.1.6]: https://github.com/rhysd/tui-textarea/compare/v0.1.5...v0.1.6 [v0.1.5]: https://github.com/rhysd/tui-textarea/compare/v0.1.4...v0.1.5 @@ -145,4 +174,4 @@ First release :tada: [v0.1.1]: https://github.com/rhysd/tui-textarea/compare/v0.1.0...v0.1.1 [v0.1.0]: https://github.com/rhysd/tui-textarea/tree/v0.1.0 - +