mirror of
https://github.com/ratatui-org/ratatui
synced 2024-11-22 04:33:13 +00:00
ed51c4b342
These are simple opinionated methods for creating a terminal that is
useful to use in most apps. The new init method creates a crossterm
backend writing to stdout, enables raw mode, enters the alternate
screen, and sets a panic handler that restores the terminal on panic.
A minimal hello world now looks a bit like:
```rust
use ratatui::{
crossterm::event::{self, Event},
text::Text,
Frame,
};
fn main() {
let mut terminal = ratatui::init();
loop {
terminal
.draw(|frame: &mut Frame| frame.render_widget(Text::raw("Hello World!"), frame.area()))
.expect("Failed to draw");
if matches!(event::read().expect("failed to read event"), Event::Key(_)) {
break;
}
}
ratatui::restore();
}
```
A type alias `DefaultTerminal` is added to represent this terminal
type and to simplify any cases where applications need to pass this
terminal around. It is equivalent to:
`Terminal<CrosstermBackend<Stdout>>`
We also added `ratatui::try_init()` and `try_restore()`, for situations
where you might want to handle initialization errors yourself instead
of letting the panic handler fire and cleanup. Simple Apps should
prefer the `init` and `restore` functions over these functions.
Corresponding functions to allow passing a `TerminalOptions` with
a `Viewport` (e.g. inline, fixed) are also available
(`init_with_options`,
and `try_init_with_options`).
The existing code to create a backend and terminal will remain and
is not deprecated by this approach. This just provides a simple one
line initialization using the common options.
---------
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
93 lines
3.2 KiB
Rust
93 lines
3.2 KiB
Rust
//! # [Ratatui] Popup example
|
|
//!
|
|
//! The latest version of this example is available in the [examples] folder in the repository.
|
|
//!
|
|
//! Please note that the examples are designed to be run against the `main` branch of the Github
|
|
//! repository. This means that you may not be able to compile with the latest release version on
|
|
//! crates.io, or the one that you have installed locally.
|
|
//!
|
|
//! See the [examples readme] for more information on finding examples that match the version of the
|
|
//! library you are using.
|
|
//!
|
|
//! [Ratatui]: https://github.com/ratatui/ratatui
|
|
//! [examples]: https://github.com/ratatui/ratatui/blob/main/examples
|
|
//! [examples readme]: https://github.com/ratatui/ratatui/blob/main/examples/README.md
|
|
|
|
// See also https://github.com/joshka/tui-popup and
|
|
// https://github.com/sephiroth74/tui-confirm-dialog
|
|
|
|
use color_eyre::Result;
|
|
use ratatui::{
|
|
crossterm::event::{self, Event, KeyCode, KeyEventKind},
|
|
layout::{Constraint, Flex, Layout, Rect},
|
|
style::Stylize,
|
|
widgets::{Block, Clear, Paragraph, Wrap},
|
|
DefaultTerminal, Frame,
|
|
};
|
|
|
|
fn main() -> Result<()> {
|
|
color_eyre::install()?;
|
|
let terminal = ratatui::init();
|
|
let app_result = App::default().run(terminal);
|
|
ratatui::restore();
|
|
app_result
|
|
}
|
|
|
|
#[derive(Default)]
|
|
struct App {
|
|
show_popup: bool,
|
|
}
|
|
|
|
impl App {
|
|
fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
|
|
loop {
|
|
terminal.draw(|frame| self.draw(frame))?;
|
|
|
|
if let Event::Key(key) = event::read()? {
|
|
if key.kind == KeyEventKind::Press {
|
|
match key.code {
|
|
KeyCode::Char('q') => return Ok(()),
|
|
KeyCode::Char('p') => self.show_popup = !self.show_popup,
|
|
_ => {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn draw(&self, frame: &mut Frame) {
|
|
let area = frame.area();
|
|
|
|
let vertical = Layout::vertical([Constraint::Percentage(20), Constraint::Percentage(80)]);
|
|
let [instructions, content] = vertical.areas(area);
|
|
|
|
let text = if self.show_popup {
|
|
"Press p to close the popup"
|
|
} else {
|
|
"Press p to show the popup"
|
|
};
|
|
let paragraph = Paragraph::new(text.slow_blink())
|
|
.centered()
|
|
.wrap(Wrap { trim: true });
|
|
frame.render_widget(paragraph, instructions);
|
|
|
|
let block = Block::bordered().title("Content").on_blue();
|
|
frame.render_widget(block, content);
|
|
|
|
if self.show_popup {
|
|
let block = Block::bordered().title("Popup");
|
|
let area = popup_area(area, 60, 20);
|
|
frame.render_widget(Clear, area); //this clears out the background
|
|
frame.render_widget(block, area);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// helper function to create a centered rect using up certain percentage of the available rect `r`
|
|
fn popup_area(area: Rect, percent_x: u16, percent_y: u16) -> Rect {
|
|
let vertical = Layout::vertical([Constraint::Percentage(percent_y)]).flex(Flex::Center);
|
|
let horizontal = Layout::horizontal([Constraint::Percentage(percent_x)]).flex(Flex::Center);
|
|
let [area] = vertical.areas(area);
|
|
let [area] = horizontal.areas(area);
|
|
area
|
|
}
|