docs: fixup remaining tui references (#106)

This commit is contained in:
Josh McKinney 2023-03-21 22:33:45 -07:00 committed by GitHub
parent 829dfee9e5
commit 2da4c10384
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 17 additions and 16 deletions

View file

@ -7,7 +7,7 @@ assignees: ''
--- ---
<!-- <!--
Hi there, sorry `tui` is not working as expected. Hi there, sorry `ratatui` is not working as expected.
Please fill this bug report conscientiously. Please fill this bug report conscientiously.
A detailed and complete issue is more likely to be processed quickly. A detailed and complete issue is more likely to be processed quickly.
--> -->

View file

@ -32,7 +32,7 @@ The only exception to this rule is if it's to fix **reproducible slowness.**
[cargo-make]: https://github.com/sagiegurari/cargo-make "cargo-make" [cargo-make]: https://github.com/sagiegurari/cargo-make "cargo-make"
`tui` is an ordinary Rust project where common tasks are managed with [cargo-make]. `ratatui` is an ordinary Rust project where common tasks are managed with [cargo-make].
It wraps common `cargo` commands with sane defaults depending on your platform of choice. It wraps common `cargo` commands with sane defaults depending on your platform of choice.
Building the project should be as easy as running `cargo make build`. Building the project should be as easy as running `cargo make build`.
@ -56,6 +56,6 @@ You can also check most of those things yourself locally using `cargo make ci` w
## Tests ## Tests
The test coverage of the crate is far from being ideal but we already have a fair amount of tests in place. The test coverage of the crate is far from being ideal but we already have a fair amount of tests in place.
Beside the usual doc and unit tests, one of the most valuable test you can write for `tui` is a test again the `TestBackend`. Beside the usual doc and unit tests, one of the most valuable test you can write for `ratatui` is a test against the `TestBackend`.
It allows you to assert the content of the output buffer that would have been flushed to the terminal after a given draw call. It allows you to assert the content of the output buffer that would have been flushed to the terminal after a given draw call.
See `widgets_block_renders` in [tests/widgets_block.rs](./tests/widget_block.rs) for an example. See `widgets_block_renders` in [tests/widgets_block.rs](./tests/widget_block.rs) for an example.

View file

@ -127,7 +127,7 @@ fn ui<B: Backend>(f: &mut Frame<B>, app: &App) {
Spans::from("with the `reset` command"), Spans::from("with the `reset` command"),
Spans::from(""), Spans::from(""),
Spans::from("with the chained panic hook enabled,"), Spans::from("with the chained panic hook enabled,"),
Spans::from("you should see the panic report as you would without tui"), Spans::from("you should see the panic report as you would without ratatui"),
Spans::from(""), Spans::from(""),
Spans::from("try first without the panic handler to see the difference"), Spans::from("try first without the panic handler to see the difference"),
]; ];

View file

@ -168,7 +168,7 @@ fn ui<B: Backend>(f: &mut Frame<B>, app: &App) {
{} {}
InputMode::Editing => { InputMode::Editing => {
// Make the cursor visible and ask tui-rs to put it at the specified coordinates after rendering // Make the cursor visible and ask ratatui to put it at the specified coordinates after rendering
f.set_cursor( f.set_cursor(
// Put cursor past the end of the input text // Put cursor past the end of the input text
chunks[1].x + app.input.width() as u16 + 1, chunks[1].x + app.input.width() as u16 + 1,

View file

@ -1,16 +1,17 @@
//! [tui](https://github.com/fdehau/tui-rs) is a library used to build rich //! [ratatui](https://github.com/tui-rs-revival/ratatui) is a library used to build rich
//! terminal users interfaces and dashboards. //! terminal users interfaces and dashboards.
//! //!
//! ![](https://raw.githubusercontent.com/fdehau/tui-rs/master/assets/demo.gif) //! ![](https://raw.githubusercontent.com/tui-rs-revival/ratatui/master/assets/demo.gif)
//! //!
//! # Get started //! # Get started
//! //!
//! ## Adding `tui` as a dependency //! ## Adding `ratatui` as a dependency
//! //!
//! Add the following to your `Cargo.toml`:
//! ```toml //! ```toml
//! [dependencies] //! [dependencies]
//! tui = "0.19" //! crossterm = "0.26"
//! crossterm = "0.25" //! ratatui = "0.20"
//! ``` //! ```
//! //!
//! The crate is using the `crossterm` backend by default that works on most platforms. But if for //! The crate is using the `crossterm` backend by default that works on most platforms. But if for
@ -20,7 +21,7 @@
//! ```toml //! ```toml
//! [dependencies] //! [dependencies]
//! termion = "1.5" //! termion = "1.5"
//! tui = { version = "0.19", default-features = false, features = ['termion'] } //! ratatui = { version = "0.20", default-features = false, features = ['termion'] }
//! //!
//! ``` //! ```
//! //!
@ -28,7 +29,7 @@
//! //!
//! ## Creating a `Terminal` //! ## Creating a `Terminal`
//! //!
//! Every application using `tui` should start by instantiating a `Terminal`. It is a light //! Every application using `ratatui` should start by instantiating a `Terminal`. It is a light
//! abstraction over available backends that provides basic functionalities such as clearing the //! abstraction over available backends that provides basic functionalities such as clearing the
//! screen, hiding the cursor, etc. //! screen, hiding the cursor, etc.
//! //!

View file

@ -1,7 +1,7 @@
//! Primitives for styled text. //! Primitives for styled text.
//! //!
//! A terminal UI is at its root a lot of strings. In order to make it accessible and stylish, //! A terminal UI is at its root a lot of strings. In order to make it accessible and stylish,
//! those strings may be associated to a set of styles. `tui` has three ways to represent them: //! those strings may be associated to a set of styles. `ratatui` has three ways to represent them:
//! - A single line string where all graphemes have the same style is represented by a [`Span`]. //! - A single line string where all graphemes have the same style is represented by a [`Span`].
//! - A single line string where each grapheme may have its own style is represented by [`Spans`]. //! - A single line string where each grapheme may have its own style is represented by [`Spans`].
//! - A multiple line string where each grapheme may have its own style is represented by a //! - A multiple line string where each grapheme may have its own style is represented by a
@ -11,7 +11,7 @@
//! is a [`Spans`]. //! is a [`Spans`].
//! //!
//! Keep it mind that a lot of widgets will use those types to advertise what kind of string is //! Keep it mind that a lot of widgets will use those types to advertise what kind of string is
//! supported for their properties. Moreover, `tui` provides convenient `From` implementations so //! supported for their properties. Moreover, `ratatui` provides convenient `From` implementations so
//! that you can start by using simple `String` or `&str` and then promote them to the previous //! that you can start by using simple `String` or `&str` and then promote them to the previous
//! primitives when you need additional styling capabilities. //! primitives when you need additional styling capabilities.
//! //!

View file

@ -2,7 +2,7 @@ use crate::{buffer::Buffer, layout::Rect, widgets::Widget};
/// A widget to clear/reset a certain area to allow overdrawing (e.g. for popups). /// A widget to clear/reset a certain area to allow overdrawing (e.g. for popups).
/// ///
/// This widget **cannot be used to clear the terminal on the first render** as `tui` assumes the /// This widget **cannot be used to clear the terminal on the first render** as `ratatui` assumes the
/// render area is empty. Use [`crate::Terminal::clear`] instead. /// render area is empty. Use [`crate::Terminal::clear`] instead.
/// ///
/// # Examples /// # Examples

View file

@ -165,7 +165,7 @@ pub trait Widget {
/// loop { /// loop {
/// terminal.draw(|f| { /// terminal.draw(|f| {
/// // The items managed by the application are transformed to something /// // The items managed by the application are transformed to something
/// // that is understood by tui. /// // that is understood by ratatui.
/// let items: Vec<ListItem>= events.items.iter().map(|i| ListItem::new(i.as_ref())).collect(); /// let items: Vec<ListItem>= events.items.iter().map(|i| ListItem::new(i.as_ref())).collect();
/// // The `List` widget is then built with those items. /// // The `List` widget is then built with those items.
/// let list = List::new(items); /// let list = List::new(items);