Cyclic0007/ratatui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Improve README examples 📚

Browse Source
This commit is contained in:
Dheepak Krishnamurthy
2024-01-09 01:50:32 -05:00
parent 8b32f82b4d
commit 76d1e5b173
1 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -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 };