diff --git a/README.md b/README.md index fe9cf52d..218899f5 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,18 @@ - [Ratatui](#ratatui) - [Installation](#installation) - [Introduction](#introduction) - - [Other Documentation](#other-documentation) + - [Other documentation](#other-documentation) - [Quickstart](#quickstart) + - [Initialize and restore the terminal](#initialize-and-restore-the-terminal) + - [Drawing the UI](#drawing-the-ui) + - [Handling events](#handling-events) + - [Example](#example) + - [Layout](#layout) + - [Text and styling](#text-and-styling) - [Status of this fork](#status-of-this-fork) - - [Rust version requirements](#rust-version-requirements) - [Widgets](#widgets) - [Built in](#built-in) - - [Third\-party libraries, bootstrapping templates and - widgets](#third-party-libraries-bootstrapping-templates-and-widgets) + - [Third-party libraries, bootstrapping templates and widgets](#third-party-libraries-bootstrapping-templates-and-widgets) - [Apps](#apps) - [Alternatives](#alternatives) - [Acknowledgments](#acknowledgments) @@ -170,7 +174,7 @@ fn handle_events() -> io::Result { fn ui(frame: &mut Frame) { frame.render_widget( Paragraph::new("Hello World!").block(Block::bordered().title("Greeting")), - frame.size(), + frame.area(), ); } ``` @@ -199,7 +203,7 @@ fn ui(frame: &mut Frame) { Constraint::Min(0), Constraint::Length(1), ]) - .areas(frame.size()); + .areas(frame.area()); let [left_area, right_area] = Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)]) .areas(main_area); @@ -237,7 +241,7 @@ use ratatui::{ }; fn ui(frame: &mut Frame) { - let areas = Layout::vertical([Constraint::Length(1); 4]).split(frame.size()); + let areas = Layout::vertical([Constraint::Length(1); 4]).split(frame.area()); let line = Line::from(vec![ Span::raw("Hello "), diff --git a/src/layout/layout.rs b/src/layout/layout.rs index c5d1452f..ae44182a 100644 --- a/src/layout/layout.rs +++ b/src/layout/layout.rs @@ -428,7 +428,7 @@ impl Layout { /// ```rust /// # use ratatui::prelude::*; /// # fn render(frame: &mut Frame) { - /// let area = frame.size(); + /// let area = frame.area(); /// let layout = Layout::vertical([Constraint::Length(1), Constraint::Min(0)]); /// let [top, main] = layout.areas(area); /// @@ -460,7 +460,7 @@ impl Layout { /// ```rust /// # use ratatui::prelude::*; /// # fn render(frame: &mut Frame) { - /// let area = frame.size(); + /// let area = frame.area(); /// let layout = Layout::vertical([Constraint::Length(1), Constraint::Min(0)]); /// let [top, main] = layout.areas(area); /// let [before, inbetween, after] = layout.spacers(area); diff --git a/src/layout/rect.rs b/src/layout/rect.rs index 7f9275cc..97497117 100644 --- a/src/layout/rect.rs +++ b/src/layout/rect.rs @@ -236,7 +236,7 @@ impl Rect { /// ```rust /// # use ratatui::prelude::*; /// # fn render(frame: &mut Frame) { - /// let area = frame.size(); + /// let area = frame.area(); /// let rect = Rect::new(0, 0, 100, 100).clamp(area); /// # } /// ``` diff --git a/src/lib.rs b/src/lib.rs index ca257ec7..2d420aba 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -151,7 +151,7 @@ //! Constraint::Min(0), //! Constraint::Length(1), //! ]) -//! .areas(frame.size()); +//! .areas(frame.area()); //! let [left_area, right_area] = //! Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)]) //! .areas(main_area); @@ -189,7 +189,7 @@ //! }; //! //! fn draw(frame: &mut Frame) { -//! let areas = Layout::vertical([Constraint::Length(1); 4]).split(frame.size()); +//! let areas = Layout::vertical([Constraint::Length(1); 4]).split(frame.area()); //! //! let line = Line::from(vec![ //! Span::raw("Hello "), diff --git a/src/terminal.rs b/src/terminal.rs index 3fe5ccf4..d379f4a2 100644 --- a/src/terminal.rs +++ b/src/terminal.rs @@ -18,7 +18,7 @@ //! let backend = CrosstermBackend::new(stdout()); //! let mut terminal = Terminal::new(backend)?; //! terminal.draw(|frame| { -//! let area = frame.size(); +//! let area = frame.area(); //! frame.render_widget(Paragraph::new("Hello world!"), area); //! })?; //! # std::io::Result::Ok(()) diff --git a/src/terminal/terminal.rs b/src/terminal/terminal.rs index 13c8212a..66343ae5 100644 --- a/src/terminal/terminal.rs +++ b/src/terminal/terminal.rs @@ -38,7 +38,7 @@ use crate::{ /// let backend = CrosstermBackend::new(stdout()); /// let mut terminal = Terminal::new(backend)?; /// terminal.draw(|frame| { -/// let area = frame.size(); +/// let area = frame.area(); /// frame.render_widget(Paragraph::new("Hello World!"), area); /// })?; /// # std::io::Result::Ok(()) @@ -283,7 +283,7 @@ where /// /// // with a closure /// terminal.draw(|frame| { - /// let area = frame.size(); + /// let area = frame.area(); /// frame.render_widget(Paragraph::new("Hello World!"), area); /// frame.set_cursor_position(Position { x: 0, y: 0 }); /// })?; @@ -292,7 +292,7 @@ where /// terminal.draw(render)?; /// /// fn render(frame: &mut ratatui::Frame) { - /// frame.render_widget(Paragraph::new("Hello World!"), frame.size()); + /// frame.render_widget(Paragraph::new("Hello World!"), frame.area()); /// } /// # std::io::Result::Ok(()) /// ``` @@ -355,7 +355,7 @@ where /// // with a closure /// terminal.try_draw(|frame| { /// let value: u8 = "not a number".parse().map_err(io::Error::other)?; - /// let area = frame.size(); + /// let area = frame.area(); /// frame.render_widget(Paragraph::new("Hello World!"), area); /// frame.set_cursor_position(Position { x: 0, y: 0 }); /// io::Result::Ok(()) @@ -366,7 +366,7 @@ where /// /// fn render(frame: &mut ratatui::Frame) -> io::Result<()> { /// let value: u8 = "not a number".parse().map_err(io::Error::other)?; - /// frame.render_widget(Paragraph::new("Hello World!"), frame.size()); + /// frame.render_widget(Paragraph::new("Hello World!"), frame.area()); /// Ok(()) /// } /// # io::Result::Ok(()) diff --git a/src/text/span.rs b/src/text/span.rs index 2e17a570..77795c18 100644 --- a/src/text/span.rs +++ b/src/text/span.rs @@ -81,7 +81,7 @@ use crate::{prelude::*, style::Styled, text::StyledGrapheme}; /// use ratatui::prelude::*; /// /// # fn render_frame(frame: &mut Frame) { -/// frame.render_widget("test content".green().on_yellow().italic(), frame.size()); +/// frame.render_widget("test content".green().on_yellow().italic(), frame.area()); /// # } /// ``` /// [`Line`]: crate::text::Line diff --git a/src/widgets.rs b/src/widgets.rs index 2d488086..99ebd124 100644 --- a/src/widgets.rs +++ b/src/widgets.rs @@ -88,7 +88,7 @@ use crate::{buffer::Buffer, layout::Rect, style::Style}; /// # let mut terminal = Terminal::new(backend).unwrap(); /// /// terminal.draw(|frame| { -/// frame.render_widget(Clear, frame.size()); +/// frame.render_widget(Clear, frame.area()); /// }); /// ``` /// diff --git a/src/widgets/block.rs b/src/widgets/block.rs index b648c3cc..9886b7f1 100644 --- a/src/widgets/block.rs +++ b/src/widgets/block.rs @@ -595,7 +595,7 @@ impl<'a> Block<'a> { /// let outer_block = Block::bordered().title("Outer"); /// let inner_block = Block::bordered().title("Inner"); /// - /// let outer_area = frame.size(); + /// let outer_area = frame.area(); /// let inner_area = outer_block.inner(outer_area); /// /// frame.render_widget(outer_block, outer_area); diff --git a/src/widgets/scrollbar.rs b/src/widgets/scrollbar.rs index ef72b548..f1e704b1 100644 --- a/src/widgets/scrollbar.rs +++ b/src/widgets/scrollbar.rs @@ -59,7 +59,7 @@ use crate::{ /// /// let mut scrollbar_state = ScrollbarState::new(items.len()).position(vertical_scroll); /// -/// let area = frame.size(); +/// let area = frame.area(); /// // Note we render the paragraph /// frame.render_widget(paragraph, area); /// // and the scrollbar, those are separate widgets