mirror of
https://github.com/ratatui/ratatui.git
synced 2025-09-29 05:51:57 +00:00

Most widgets can be drawn directly based on the input parameters. However, some features may require some kind of associated state to be implemented. For example, the `List` widget can highlight the item currently selected. This can be translated in an offset, which is the number of elements to skip in order to have the selected item within the viewport currently allocated to this widget. The widget can therefore only provide the following behavior: whenever the selected item is out of the viewport scroll to a predefined position (make the selected item the last viewable item or the one in the middle). Nonetheless, if the widget has access to the last computed offset then it can implement a natural scrolling experience where the last offset is reused until the selected item is out of the viewport. To allow such behavior within the widgets, this commit introduces the following changes: - Add a `StatefulWidget` trait with an associated `State` type. Widgets that can take advantage of having a "memory" between two draw calls needs to implement this trait. - Add a `render_stateful_widget` method on `Frame` where the associated state is given as a parameter. The chosen approach is thus to let the developers manage their widgets' states themselves as they are already responsible for the lifecycle of the wigets (given that the crate exposes an immediate mode api). The following changes were also introduced: - `Widget::render` has been deleted. Developers should use `Frame::render_widget` instead. - `Widget::background` has been deleted. Developers should use `Buffer::set_background` instead. - `SelectableList` has been deleted. Developers can directly use `List` where `SelectableList` features have been back-ported.
294 lines
10 KiB
Rust
294 lines
10 KiB
Rust
use tui::backend::Backend;
|
|
use tui::layout::{Constraint, Direction, Layout, Rect};
|
|
use tui::style::{Color, Modifier, Style};
|
|
use tui::widgets::canvas::{Canvas, Line, Map, MapResolution, Rectangle};
|
|
use tui::widgets::{
|
|
Axis, BarChart, Block, Borders, Chart, Dataset, Gauge, List, Marker, Paragraph, Row, Sparkline,
|
|
Table, Tabs, Text,
|
|
};
|
|
use tui::Frame;
|
|
|
|
use crate::demo::App;
|
|
|
|
pub fn draw<B: Backend>(f: &mut Frame<B>, app: &mut App) {
|
|
let chunks = Layout::default()
|
|
.constraints([Constraint::Length(3), Constraint::Min(0)].as_ref())
|
|
.split(f.size());
|
|
let tabs = Tabs::default()
|
|
.block(Block::default().borders(Borders::ALL).title(app.title))
|
|
.titles(&app.tabs.titles)
|
|
.style(Style::default().fg(Color::Green))
|
|
.highlight_style(Style::default().fg(Color::Yellow))
|
|
.select(app.tabs.index);
|
|
f.render_widget(tabs, chunks[0]);
|
|
match app.tabs.index {
|
|
0 => draw_first_tab(f, app, chunks[1]),
|
|
1 => draw_second_tab(f, app, chunks[1]),
|
|
_ => {}
|
|
};
|
|
}
|
|
|
|
fn draw_first_tab<B>(f: &mut Frame<B>, app: &mut App, area: Rect)
|
|
where
|
|
B: Backend,
|
|
{
|
|
let chunks = Layout::default()
|
|
.constraints(
|
|
[
|
|
Constraint::Length(7),
|
|
Constraint::Min(7),
|
|
Constraint::Length(7),
|
|
]
|
|
.as_ref(),
|
|
)
|
|
.split(area);
|
|
draw_gauges(f, app, chunks[0]);
|
|
draw_charts(f, app, chunks[1]);
|
|
draw_text(f, chunks[2]);
|
|
}
|
|
|
|
fn draw_gauges<B>(f: &mut Frame<B>, app: &mut App, area: Rect)
|
|
where
|
|
B: Backend,
|
|
{
|
|
let chunks = Layout::default()
|
|
.constraints([Constraint::Length(2), Constraint::Length(3)].as_ref())
|
|
.margin(1)
|
|
.split(area);
|
|
let block = Block::default().borders(Borders::ALL).title("Graphs");
|
|
f.render_widget(block, area);
|
|
|
|
let label = format!("{} / 100", app.progress);
|
|
let gauge = Gauge::default()
|
|
.block(Block::default().title("Gauge:"))
|
|
.style(
|
|
Style::default()
|
|
.fg(Color::Magenta)
|
|
.bg(Color::Black)
|
|
.modifier(Modifier::ITALIC | Modifier::BOLD),
|
|
)
|
|
.label(&label)
|
|
.percent(app.progress);
|
|
f.render_widget(gauge, chunks[0]);
|
|
|
|
let sparkline = Sparkline::default()
|
|
.block(Block::default().title("Sparkline:"))
|
|
.style(Style::default().fg(Color::Green))
|
|
.data(&app.sparkline.points);
|
|
f.render_widget(sparkline, chunks[1]);
|
|
}
|
|
|
|
fn draw_charts<B>(f: &mut Frame<B>, app: &mut App, area: Rect)
|
|
where
|
|
B: Backend,
|
|
{
|
|
let constraints = if app.show_chart {
|
|
vec![Constraint::Percentage(50), Constraint::Percentage(50)]
|
|
} else {
|
|
vec![Constraint::Percentage(100)]
|
|
};
|
|
let chunks = Layout::default()
|
|
.constraints(constraints)
|
|
.direction(Direction::Horizontal)
|
|
.split(area);
|
|
{
|
|
let chunks = Layout::default()
|
|
.constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref())
|
|
.split(chunks[0]);
|
|
{
|
|
let chunks = Layout::default()
|
|
.constraints([Constraint::Percentage(50), Constraint::Percentage(50)].as_ref())
|
|
.direction(Direction::Horizontal)
|
|
.split(chunks[0]);
|
|
|
|
// Draw tasks
|
|
let tasks = app.tasks.items.iter().map(|i| Text::raw(*i));
|
|
let tasks = List::new(tasks)
|
|
.block(Block::default().borders(Borders::ALL).title("List"))
|
|
.highlight_style(Style::default().fg(Color::Yellow).modifier(Modifier::BOLD))
|
|
.highlight_symbol(">");
|
|
f.render_stateful_widget(tasks, chunks[0], &mut app.tasks.state);
|
|
|
|
// Draw logs
|
|
let info_style = Style::default().fg(Color::White);
|
|
let warning_style = Style::default().fg(Color::Yellow);
|
|
let error_style = Style::default().fg(Color::Magenta);
|
|
let critical_style = Style::default().fg(Color::Red);
|
|
let logs = app.logs.items.iter().map(|&(evt, level)| {
|
|
Text::styled(
|
|
format!("{}: {}", level, evt),
|
|
match level {
|
|
"ERROR" => error_style,
|
|
"CRITICAL" => critical_style,
|
|
"WARNING" => warning_style,
|
|
_ => info_style,
|
|
},
|
|
)
|
|
});
|
|
let logs = List::new(logs).block(Block::default().borders(Borders::ALL).title("List"));
|
|
f.render_stateful_widget(logs, chunks[1], &mut app.logs.state);
|
|
}
|
|
|
|
let barchart = BarChart::default()
|
|
.block(Block::default().borders(Borders::ALL).title("Bar chart"))
|
|
.data(&app.barchart)
|
|
.bar_width(3)
|
|
.bar_gap(2)
|
|
.value_style(
|
|
Style::default()
|
|
.fg(Color::Black)
|
|
.bg(Color::Green)
|
|
.modifier(Modifier::ITALIC),
|
|
)
|
|
.label_style(Style::default().fg(Color::Yellow))
|
|
.style(Style::default().fg(Color::Green));
|
|
f.render_widget(barchart, chunks[1]);
|
|
}
|
|
if app.show_chart {
|
|
let x_labels = [
|
|
format!("{}", app.signals.window[0]),
|
|
format!("{}", (app.signals.window[0] + app.signals.window[1]) / 2.0),
|
|
format!("{}", app.signals.window[1]),
|
|
];
|
|
let datasets = [
|
|
Dataset::default()
|
|
.name("data2")
|
|
.marker(Marker::Dot)
|
|
.style(Style::default().fg(Color::Cyan))
|
|
.data(&app.signals.sin1.points),
|
|
Dataset::default()
|
|
.name("data3")
|
|
.marker(Marker::Braille)
|
|
.style(Style::default().fg(Color::Yellow))
|
|
.data(&app.signals.sin2.points),
|
|
];
|
|
let chart = Chart::default()
|
|
.block(
|
|
Block::default()
|
|
.title("Chart")
|
|
.title_style(Style::default().fg(Color::Cyan).modifier(Modifier::BOLD))
|
|
.borders(Borders::ALL),
|
|
)
|
|
.x_axis(
|
|
Axis::default()
|
|
.title("X Axis")
|
|
.style(Style::default().fg(Color::Gray))
|
|
.labels_style(Style::default().modifier(Modifier::ITALIC))
|
|
.bounds(app.signals.window)
|
|
.labels(&x_labels),
|
|
)
|
|
.y_axis(
|
|
Axis::default()
|
|
.title("Y Axis")
|
|
.style(Style::default().fg(Color::Gray))
|
|
.labels_style(Style::default().modifier(Modifier::ITALIC))
|
|
.bounds([-20.0, 20.0])
|
|
.labels(&["-20", "0", "20"]),
|
|
)
|
|
.datasets(&datasets);
|
|
f.render_widget(chart, chunks[1]);
|
|
}
|
|
}
|
|
|
|
fn draw_text<B>(f: &mut Frame<B>, area: Rect)
|
|
where
|
|
B: Backend,
|
|
{
|
|
let text = [
|
|
Text::raw("This is a paragraph with several lines. You can change style your text the way you want.\n\nFox example: "),
|
|
Text::styled("under", Style::default().fg(Color::Red)),
|
|
Text::raw(" "),
|
|
Text::styled("the", Style::default().fg(Color::Green)),
|
|
Text::raw(" "),
|
|
Text::styled("rainbow", Style::default().fg(Color::Blue)),
|
|
Text::raw(".\nOh and if you didn't "),
|
|
Text::styled("notice", Style::default().modifier(Modifier::ITALIC)),
|
|
Text::raw(" you can "),
|
|
Text::styled("automatically", Style::default().modifier(Modifier::BOLD)),
|
|
Text::raw(" "),
|
|
Text::styled("wrap", Style::default().modifier(Modifier::REVERSED)),
|
|
Text::raw(" your "),
|
|
Text::styled("text", Style::default().modifier(Modifier::UNDERLINED)),
|
|
Text::raw(".\nOne more thing is that it should display unicode characters: 10€")
|
|
];
|
|
let block = Block::default()
|
|
.borders(Borders::ALL)
|
|
.title("Footer")
|
|
.title_style(Style::default().fg(Color::Magenta).modifier(Modifier::BOLD));
|
|
let paragraph = Paragraph::new(text.iter()).block(block).wrap(true);
|
|
f.render_widget(paragraph, area);
|
|
}
|
|
|
|
fn draw_second_tab<B>(f: &mut Frame<B>, app: &mut App, area: Rect)
|
|
where
|
|
B: Backend,
|
|
{
|
|
let chunks = Layout::default()
|
|
.constraints([Constraint::Percentage(30), Constraint::Percentage(70)].as_ref())
|
|
.direction(Direction::Horizontal)
|
|
.split(area);
|
|
let up_style = Style::default().fg(Color::Green);
|
|
let failure_style = Style::default()
|
|
.fg(Color::Red)
|
|
.modifier(Modifier::RAPID_BLINK | Modifier::CROSSED_OUT);
|
|
let header = ["Server", "Location", "Status"];
|
|
let rows = app.servers.iter().map(|s| {
|
|
let style = if s.status == "Up" {
|
|
up_style
|
|
} else {
|
|
failure_style
|
|
};
|
|
Row::StyledData(vec![s.name, s.location, s.status].into_iter(), style)
|
|
});
|
|
let table = Table::new(header.iter(), rows)
|
|
.block(Block::default().title("Servers").borders(Borders::ALL))
|
|
.header_style(Style::default().fg(Color::Yellow))
|
|
.widths(&[
|
|
Constraint::Length(15),
|
|
Constraint::Length(15),
|
|
Constraint::Length(10),
|
|
]);
|
|
f.render_widget(table, chunks[0]);
|
|
|
|
let map = Canvas::default()
|
|
.block(Block::default().title("World").borders(Borders::ALL))
|
|
.paint(|ctx| {
|
|
ctx.draw(&Map {
|
|
color: Color::White,
|
|
resolution: MapResolution::High,
|
|
});
|
|
ctx.layer();
|
|
ctx.draw(&Rectangle {
|
|
rect: Rect {
|
|
x: 0,
|
|
y: 30,
|
|
width: 10,
|
|
height: 10,
|
|
},
|
|
color: Color::Yellow,
|
|
});
|
|
for (i, s1) in app.servers.iter().enumerate() {
|
|
for s2 in &app.servers[i + 1..] {
|
|
ctx.draw(&Line {
|
|
x1: s1.coords.1,
|
|
y1: s1.coords.0,
|
|
y2: s2.coords.0,
|
|
x2: s2.coords.1,
|
|
color: Color::Yellow,
|
|
});
|
|
}
|
|
}
|
|
for server in &app.servers {
|
|
let color = if server.status == "Up" {
|
|
Color::Green
|
|
} else {
|
|
Color::Red
|
|
};
|
|
ctx.print(server.coords.1, server.coords.0, "X", color);
|
|
}
|
|
})
|
|
.x_bounds([-180.0, 180.0])
|
|
.y_bounds([-90.0, 90.0]);
|
|
f.render_widget(map, chunks[1]);
|
|
}
|