Popup
Demonstrates how to render a widget over the top of previously rendered widgets using the
Clear
widget.
git clone https://github.com/ratatui-org/ratatui.git --branch latestcd ratatuicargo run --example=popup --features=crossterm
//! # [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-org/ratatui//! [examples]: https://github.com/ratatui-org/ratatui/blob/main/examples//! [examples readme]: https://github.com/ratatui-org/ratatui/blob/main/examples/README.md
// See also https://github.com/joshka/tui-popup and// https://github.com/sephiroth74/tui-confirm-dialog
use std::{error::Error, io};
use ratatui::{ crossterm::{ event::{self, DisableMouseCapture, EnableMouseCapture, Event, KeyCode, KeyEventKind}, execute, terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen}, }, prelude::*, widgets::{Block, Clear, Paragraph, Wrap},};
struct App { show_popup: bool,}
impl App { const fn new() -> Self { Self { show_popup: false } }}
fn main() -> Result<(), Box<dyn Error>> { // setup terminal enable_raw_mode()?; let mut stdout = io::stdout(); execute!(stdout, EnterAlternateScreen, EnableMouseCapture)?; let backend = CrosstermBackend::new(stdout); let mut terminal = Terminal::new(backend)?;
// create app and run it let app = App::new(); let res = run_app(&mut terminal, app);
// restore terminal disable_raw_mode()?; execute!( terminal.backend_mut(), LeaveAlternateScreen, DisableMouseCapture )?; terminal.show_cursor()?;
if let Err(err) = res { println!("{err:?}"); }
Ok(())}
fn run_app<B: Backend>(terminal: &mut Terminal<B>, mut app: App) -> io::Result<()> { loop { terminal.draw(|f| ui(f, &app))?;
if let Event::Key(key) = event::read()? { if key.kind == KeyEventKind::Press { match key.code { KeyCode::Char('q') => return Ok(()), KeyCode::Char('p') => app.show_popup = !app.show_popup, _ => {} } } } }}
fn ui(f: &mut Frame, app: &App) { let area = f.size();
let vertical = Layout::vertical([Constraint::Percentage(20), Constraint::Percentage(80)]); let [instructions, content] = vertical.areas(area);
let text = if app.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 }); f.render_widget(paragraph, instructions);
let block = Block::bordered().title("Content").on_blue(); f.render_widget(block, content);
if app.show_popup { let block = Block::bordered().title("Popup"); let area = centered_rect(60, 20, area); f.render_widget(Clear, area); //this clears out the background f.render_widget(block, area); }}
/// helper function to create a centered rect using up certain percentage of the available rect `r`fn centered_rect(percent_x: u16, percent_y: u16, r: Rect) -> Rect { let popup_layout = Layout::vertical([ Constraint::Percentage((100 - percent_y) / 2), Constraint::Percentage(percent_y), Constraint::Percentage((100 - percent_y) / 2), ]) .split(r);
Layout::horizontal([ Constraint::Percentage((100 - percent_x) / 2), Constraint::Percentage(percent_x), Constraint::Percentage((100 - percent_x) / 2), ]) .split(popup_layout[1])[1]}