docs: use ratatui 0.28.1 methods for examples

Author: joshka

tui-scrollview/examples/scrollview.rs

@@ -1,25 +1,23 @@
-use std::io::{self, stdout};
+use std::io::{self};
 
-use color_eyre::{config::HookBuilder, Result};
+use color_eyre::Result;
 use ratatui::{
-    crossterm::{
-        event::{self, Event, KeyCode, KeyEventKind},
-        terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
-        ExecutableCommand,
-    },
-    layout::Size,
-    prelude::*,
-    style::palette::tailwind,
+    buffer::Buffer,
+    crossterm::event::{self, Event, KeyCode, KeyEventKind},
+    layout::{Constraint, Direction, Layout, Rect, Size},
+    style::{palette::tailwind, Color, Stylize},
+    text::{Line, Text},
     widgets::*,
+    DefaultTerminal,
 };
 use tui_scrollview::{ScrollView, ScrollViewState};
 
 fn main() -> Result<()> {
-    init_error_hooks()?;
-    let terminal = init_terminal()?;
-    App::new().run(terminal)?;
-    restore_terminal()?;
-    Ok(())
+    color_eyre::install()?;
+    let terminal = ratatui::init();
+    let result = App::new().run(terminal);
+    ratatui::restore();
+    result
 }
 
 #[derive(Debug, Default, Clone)]
@@ -48,11 +46,10 @@ impl App {
         }
     }
 
-    fn run(&mut self, mut terminal: Terminal<impl Backend>) -> Result<()> {
-        self.draw(&mut terminal)?;
+    fn run(&mut self, mut terminal: DefaultTerminal) -> Result<()> {
         while self.is_running() {
-            self.handle_events()?;
             self.draw(&mut terminal)?;
+            self.handle_events()?;
         }
         Ok(())
     }
@@ -61,7 +58,7 @@ impl App {
         self.state == AppState::Running
     }
 
-    fn draw(&mut self, terminal: &mut Terminal<impl Backend>) -> io::Result<()> {
+    fn draw(&mut self, terminal: &mut DefaultTerminal) -> io::Result<()> {
         terminal.draw(|frame| frame.render_widget(self, frame.area()))?;
         Ok(())
     }
@@ -190,32 +187,3 @@ fn bars() -> BarGroup<'static> {
         .map(|(label, value, color)| Bar::default().label(label.into()).value(value).style(color));
     BarGroup::default().bars(&data)
 }
-
-fn init_error_hooks() -> Result<()> {
-    let (panic, error) = HookBuilder::default().into_hooks();
-    let panic = panic.into_panic_hook();
-    let error = error.into_eyre_hook();
-    color_eyre::eyre::set_hook(Box::new(move |e| {
-        let _ = restore_terminal();
-        error(e)
-    }))?;
-    std::panic::set_hook(Box::new(move |info| {
-        let _ = restore_terminal();
-        panic(info)
-    }));
-    Ok(())
-}
-
-fn init_terminal() -> Result<Terminal<impl Backend>> {
-    enable_raw_mode()?;
-    stdout().execute(EnterAlternateScreen)?;
-    let backend = CrosstermBackend::new(stdout());
-    let terminal = Terminal::new(backend)?;
-    Ok(terminal)
-}
-
-fn restore_terminal() -> Result<()> {
-    disable_raw_mode()?;
-    stdout().execute(LeaveAlternateScreen)?;
-    Ok(())
-}

tui-scrollview/examples/tabs.rs

@@ -16,17 +16,16 @@ use ratatui::{
     style::{palette::tailwind, Stylize},
     text::Line,
     widgets::{Paragraph, StatefulWidget, StatefulWidgetRef, Tabs, Widget, Wrap},
+    DefaultTerminal,
 };
-use tui::Tui;
 use tui_scrollview::{ScrollView, ScrollViewState};
 
 fn main() -> Result<()> {
-    tui::init_error_hooks()?;
-    let terminal = tui::init_terminal()?;
-    let app = &mut App::new();
-    app.run(terminal)?;
-    tui::restore_terminal()?;
-    Ok(())
+    color_eyre::install()?;
+    let terminal = ratatui::init();
+    let result = App::new().run(terminal);
+    ratatui::restore();
+    result
 }
 
 #[derive(Default)]
@@ -121,9 +120,9 @@ impl App {
         }
     }
 
-    fn run(&mut self, mut tui: Tui) -> Result<()> {
+    fn run(&mut self, mut terminal: DefaultTerminal) -> Result<()> {
         while self.is_running() {
-            self.draw(&mut tui)?;
+            self.draw(&mut terminal)?;
             self.handle_events()?;
         }
         Ok(())
@@ -133,8 +132,8 @@ impl App {
         self.state == AppState::Running
     }
 
-    fn draw(&mut self, tui: &mut Tui) -> io::Result<()> {
-        tui.draw(|frame| frame.render_widget(self, frame.area()))?;
+    fn draw(&mut self, terminal: &mut DefaultTerminal) -> io::Result<()> {
+        terminal.draw(|frame| frame.render_widget(self, frame.area()))?;
         Ok(())
     }
 
@@ -277,54 +276,3 @@ impl StatefulWidgetRef for BlueTab {
         scroll_view.render(area, buf, state);
     }
 }
-
-mod tui {
-    use std::{
-        io::{self, stdout, Stdout},
-        panic,
-    };
-
-    use color_eyre::{config::HookBuilder, eyre, Result};
-    use ratatui::{
-        backend::CrosstermBackend,
-        crossterm::{
-            terminal::{
-                disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen,
-            },
-            ExecutableCommand,
-        },
-        Terminal,
-    };
-
-    // a type alias to simplify the use of the crossterm backend
-    pub type Tui = Terminal<CrosstermBackend<Stdout>>;
-
-    pub fn init_error_hooks() -> Result<()> {
-        let (panic, error) = HookBuilder::default().into_hooks();
-        let panic = panic.into_panic_hook();
-        let error = error.into_eyre_hook();
-        eyre::set_hook(Box::new(move |e| {
-            let _ = restore_terminal();
-            error(e)
-        }))?;
-        panic::set_hook(Box::new(move |info| {
-            let _ = restore_terminal();
-            panic(info)
-        }));
-        Ok(())
-    }
-
-    pub fn init_terminal() -> io::Result<Tui> {
-        enable_raw_mode()?;
-        stdout().execute(EnterAlternateScreen)?;
-        let backend = CrosstermBackend::new(stdout());
-        let terminal = Terminal::new(backend)?;
-        Ok(terminal)
-    }
-
-    pub fn restore_terminal() -> io::Result<()> {
-        disable_raw_mode()?;
-        stdout().execute(LeaveAlternateScreen)?;
-        Ok(())
-    }
-}