mirror of
https://github.com/ratatui-org/ratatui
synced 2024-09-20 06:31:59 +00:00
a23ecd9b45
Code which previously called `buf.get(x, y)` or `buf.get_mut(x, y)`
should now use index operators, or be transitioned to `buff.cell()` or
`buf.cell_mut()` for safe access that avoids panics by returning
`Option<&Cell>` and `Option<&mut Cell>`.
The new methods accept `Into<Position>` instead of `x` and `y`
coordinates, which makes them more ergonomic to use.
```rust
let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 10));
let cell = buf[(0, 0)];
let cell = buf[Position::new(0, 0)];
let symbol = buf.cell((0, 0)).map(|cell| cell.symbol());
let symbol = buf.cell(Position::new(0, 0)).map(|cell| cell.symbol());
buf[(0, 0)].set_symbol("🐀");
buf[Position::new(0, 0)].set_symbol("🐀");
buf.cell_mut((0, 0)).map(|cell| cell.set_symbol("🐀"));
buf.cell_mut(Position::new(0, 0)).map(|cell| cell.set_symbol("🐀"));
```
The existing `get()` and `get_mut()` methods are marked as deprecated.
These are fairly widely used and we will leave these methods around on
the buffer for a longer time than our normal deprecation approach (2
major release)
Addresses part of: https://github.com/ratatui-org/ratatui/issues/1011
---------
Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de>
109 lines
2.7 KiB
Rust
109 lines
2.7 KiB
Rust
use std::io;
|
|
|
|
use ratatui::{
|
|
backend::TestBackend,
|
|
buffer::Buffer,
|
|
layout::Rect,
|
|
style::{Color, Style, Stylize},
|
|
widgets::{BarChart, Block, Paragraph},
|
|
Terminal,
|
|
};
|
|
|
|
#[test]
|
|
fn barchart_can_be_stylized() {
|
|
let barchart = BarChart::default()
|
|
.on_white()
|
|
.bar_style(Style::new().red())
|
|
.bar_width(2)
|
|
.value_style(Style::new().green())
|
|
.label_style(Style::new().blue())
|
|
.data(&[("A", 1), ("B", 2), ("C", 3)])
|
|
.max(3);
|
|
|
|
let area = Rect::new(0, 0, 9, 5);
|
|
let mut terminal = Terminal::new(TestBackend::new(9, 6)).unwrap();
|
|
terminal
|
|
.draw(|f| {
|
|
f.render_widget(barchart, area);
|
|
})
|
|
.unwrap();
|
|
|
|
let mut expected = Buffer::with_lines([
|
|
" ██ ",
|
|
" ▅▅ ██ ",
|
|
"▂▂ ██ ██ ",
|
|
"1█ 2█ 3█ ",
|
|
"A B C ",
|
|
" ",
|
|
]);
|
|
for y in area.y..area.height {
|
|
// background
|
|
for x in area.x..area.width {
|
|
expected[(x, y)].set_bg(Color::White);
|
|
}
|
|
// bars
|
|
for x in [0, 1, 3, 4, 6, 7] {
|
|
expected[(x, y)].set_fg(Color::Red);
|
|
}
|
|
}
|
|
// values
|
|
for x in 0..3 {
|
|
expected[(x * 3, 3)].set_fg(Color::Green);
|
|
}
|
|
// labels
|
|
for x in 0..3 {
|
|
expected[(x * 3, 4)].set_fg(Color::Blue);
|
|
expected[(x * 3 + 1, 4)].set_fg(Color::Reset);
|
|
}
|
|
terminal.backend().assert_buffer(&expected);
|
|
}
|
|
|
|
#[test]
|
|
fn block_can_be_stylized() -> io::Result<()> {
|
|
let block = Block::bordered()
|
|
.title("Title".light_blue())
|
|
.on_cyan()
|
|
.cyan();
|
|
|
|
let area = Rect::new(0, 0, 8, 3);
|
|
let mut terminal = Terminal::new(TestBackend::new(11, 4))?;
|
|
terminal.draw(|f| {
|
|
f.render_widget(block, area);
|
|
})?;
|
|
|
|
#[rustfmt::skip]
|
|
let mut expected = Buffer::with_lines([
|
|
"┌Title─┐ ",
|
|
"│ │ ",
|
|
"└──────┘ ",
|
|
" ",
|
|
]);
|
|
for x in area.x..area.width {
|
|
for y in area.y..area.height {
|
|
expected[(x, y)].set_fg(Color::Cyan).set_bg(Color::Cyan);
|
|
}
|
|
}
|
|
for x in 1..=5 {
|
|
expected[(x, 0)].set_fg(Color::LightBlue);
|
|
}
|
|
terminal.backend().assert_buffer(&expected);
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn paragraph_can_be_stylized() -> io::Result<()> {
|
|
let paragraph = Paragraph::new("Text".cyan());
|
|
|
|
let area = Rect::new(0, 0, 10, 1);
|
|
let mut terminal = Terminal::new(TestBackend::new(10, 1))?;
|
|
terminal.draw(|f| {
|
|
f.render_widget(paragraph, area);
|
|
})?;
|
|
|
|
let mut expected = Buffer::with_lines(["Text "]);
|
|
for x in 0..4 {
|
|
expected[(x, 0)].set_fg(Color::Cyan);
|
|
}
|
|
terminal.backend().assert_buffer(&expected);
|
|
Ok(())
|
|
}
|