ed51c4b(terminal) Add ratatui::init() and restore() methods by @joshka in #1289
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:
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).
ed51c4b(terminal) Add ratatui::init() and restore() methods by @joshka in #1289
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:
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
... (truncated)
Commits
3a90e2a chore(release): prepare for 0.28.1 (#1343)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps ratatui from 0.28.0 to 0.28.1.
Release notes
Sourced from ratatui's releases.
... (truncated)
Changelog
Sourced from ratatui's changelog.
... (truncated)
Commits
3a90e2a
chore(release): prepare for 0.28.1 (#1343)65da535
chore(ci): update release strategy (#1337)9ed85fd
docs(table): fix incorrect backticks inTableState
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)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show