8d60e96b2b
Crossterm 0.29 introduced methods to easily check / extract the event type. E.g. as_key_press_event() and is_key_press(). This commit updates the examples to use these methods instead of matching on the event type. This makes the code cleaner and easier to read. Also does a general cleanup of the event handling code in the examples.
91 lines
2.8 KiB
Rust
91 lines
2.8 KiB
Rust
/// A Ratatui example that how to create hyperlinks in the terminal using [OSC 8].
|
|
///
|
|
/// This example runs with the Ratatui library code in the branch that you are currently
|
|
/// reading. See the [`latest`] branch for the code which works with the most recent Ratatui
|
|
/// release.
|
|
///
|
|
/// [`latest`]: https://github.com/ratatui/ratatui/tree/latest
|
|
/// [OSC 8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
|
|
use color_eyre::Result;
|
|
use crossterm::event::{self, KeyCode};
|
|
use itertools::Itertools;
|
|
use ratatui::buffer::Buffer;
|
|
use ratatui::layout::Rect;
|
|
use ratatui::style::Stylize;
|
|
use ratatui::text::{Line, Text};
|
|
use ratatui::widgets::Widget;
|
|
use ratatui::DefaultTerminal;
|
|
|
|
fn main() -> Result<()> {
|
|
color_eyre::install()?;
|
|
let terminal = ratatui::init();
|
|
let app_result = App::new().run(terminal);
|
|
ratatui::restore();
|
|
app_result
|
|
}
|
|
|
|
struct App {
|
|
hyperlink: Hyperlink<'static>,
|
|
}
|
|
|
|
impl App {
|
|
fn new() -> Self {
|
|
let text = Line::from(vec!["Example ".into(), "hyperlink".blue()]);
|
|
let hyperlink = Hyperlink::new(text, "https://example.com");
|
|
Self { hyperlink }
|
|
}
|
|
|
|
fn run(self, mut terminal: DefaultTerminal) -> Result<()> {
|
|
loop {
|
|
terminal.draw(|frame| frame.render_widget(&self.hyperlink, frame.area()))?;
|
|
if event::read()?
|
|
.as_key_press_event()
|
|
.is_some_and(|key| matches!(key.code, KeyCode::Char('q') | KeyCode::Esc))
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
/// A hyperlink widget that renders a hyperlink in the terminal using [OSC 8].
|
|
///
|
|
/// [OSC 8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
|
|
struct Hyperlink<'content> {
|
|
text: Text<'content>,
|
|
url: String,
|
|
}
|
|
|
|
impl<'content> Hyperlink<'content> {
|
|
fn new(text: impl Into<Text<'content>>, url: impl Into<String>) -> Self {
|
|
Self {
|
|
text: text.into(),
|
|
url: url.into(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Widget for &Hyperlink<'_> {
|
|
fn render(self, area: Rect, buffer: &mut Buffer) {
|
|
(&self.text).render(area, buffer);
|
|
|
|
// this is a hacky workaround for https://github.com/ratatui/ratatui/issues/902, a bug
|
|
// in the terminal code that incorrectly calculates the width of ANSI escape sequences. It
|
|
// works by rendering the hyperlink as a series of 2-character chunks, which is the
|
|
// calculated width of the hyperlink text.
|
|
for (i, two_chars) in self
|
|
.text
|
|
.to_string()
|
|
.chars()
|
|
.chunks(2)
|
|
.into_iter()
|
|
.enumerate()
|
|
{
|
|
let text = two_chars.collect::<String>();
|
|
let hyperlink = format!("\x1B]8;;{}\x07{}\x1B]8;;\x07", self.url, text);
|
|
buffer[(area.x + i as u16 * 2, area.y)].set_symbol(hyperlink.as_str());
|
|
}
|
|
}
|
|
}
|