From 76d1e5b1733d47a7f05acf563db26cb1a66b540d Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Tue, 9 Jan 2024 01:50:32 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20Improve=20README=20examples=20?= =?UTF-8?q?=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2c18f46b..8d8b9846 100644 --- a/README.md +++ b/README.md @@ -32,37 +32,49 @@ use ratatui_macros::{constraints, vertical, horizontal}; Use the `constraints!` macro to define layout constraints: ```rust +use ratatui::prelude::*; use ratatui_macros::constraints; assert_eq!( constraints![==50, ==30%, >=3, <=1, ==1/2], [ - ratatui::prelude::Constraint::Length(50), - ratatui::prelude::Constraint::Percentage(30), - ratatui::prelude::Constraint::Min(3), - ratatui::prelude::Constraint::Max(1), - ratatui::prelude::Constraint::Ratio(1, 2), + Constraint::Length(50), + Constraint::Percentage(30), + Constraint::Min(3), + Constraint::Max(1), + Constraint::Ratio(1, 2), ] ) ``` ```rust +use ratatui::prelude::*; use ratatui_macros::constraints; assert_eq!( constraints![==1/4; 4], [ - ratatui::prelude::Constraint::Ratio(1, 4), - ratatui::prelude::Constraint::Ratio(1, 4), - ratatui::prelude::Constraint::Ratio(1, 4), - ratatui::prelude::Constraint::Ratio(1, 4), + Constraint::Ratio(1, 4), + Constraint::Ratio(1, 4), + Constraint::Ratio(1, 4), + Constraint::Ratio(1, 4), ] ) ``` +You can also use the `constraint!` macro to define individual constraints: + +```rust +use ratatui::prelude::*; +use ratatui_macros::constraint; +assert_eq!( + constraint!(==50), Constraint::Length(50), +) +``` + Create vertical and horizontal layouts using the `vertical!` and `horizontal!` macros: ```rust +use ratatui::prelude::*; use ratatui_macros::{vertical, horizontal}; -use ratatui::prelude::Rect; let area = Rect { x: 0, y: 0, width: 10, height: 10 };