Sourced from ratatui's releases.
v0.28.1
v0.28.1 - 2024-08-25
Features
ed51c4b (terminal) Add ratatui::init() and restore() methods by
@joshkain #1289These 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:
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
DefaultTerminalis 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()andtry_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 theinitandrestorefunctions over these functions.Corresponding functions to allow passing a
TerminalOptionswith aViewport(e.g. inline, fixed) are also available (init_with_options, andtry_init_with_options).
... (truncated)
Sourced from ratatui's changelog.
v0.28.1 - 2024-08-25
Features
ed51c4b (terminal) Add ratatui::init() and restore() methods by
@joshkain #1289These 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:
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
DefaultTerminalis 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()andtry_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 theinitandrestorefunctions over these functions.Corresponding functions to allow passing a
TerminalOptionswith aViewport(e.g. inline, fixed) are also available (init_with_options, andtry_init_with_options).The existing code to create a backend and terminal will remain and
... (truncated)
3a90e2a
chore(release): prepare for 0.28.1 (#1343)65da535
chore(ci): update release strategy (#1337)9ed85fd
docs(table): fix incorrect backticks in TableState docs (#1342)aed60b9
fix(terminal): Terminal::insert_before would crash when called while the
view...3631b34
docs(examples): add widget implementation example (#1147)0d5f3c0
test: Avoid unneeded allocations in assertions (#1335)ed51c4b
feat(terminal): Add ratatui::init() and restore() methods (#1289)23516bc
chore: rename ratatui-org to ratatui (#1334)6d1bd99
docs: minor grammar fixes (#1330)2fb0b8a
fix: fix u16 overflow in Terminal::insert_before. (#1323)