Struct ImageWidget 

pub struct ImageWidget { /* private fields */ }

A widget that displays an inline terminal image.

The component renders placeholder text lines that reserve the same number of cells the terminal will use for the image, and emits an ImageCommand so the renderer can upload the image using the selected terminal graphics protocol (Kitty or iTerm2).

Implementations

impl ImageWidget

pub fn new( data: Vec<u8>, mime_type: impl Into<String>, placeholder: Option<String>, ) -> Self

Create a new image widget.

data is the raw image bytes. placeholder defaults to "[image]". The widget is assigned a unique image id and uses the Kitty protocol by default. The display size in cells is inferred from the image’s pixel dimensions when possible, falling back to 20×10 cells.

pub fn with_protocol(self, protocol: ImageProtocol) -> Self

Override the terminal image protocol used by this widget.

pub fn with_size(self, cols: u16, rows: u16) -> Self

Set the on-screen size in terminal cells.

This determines how many placeholder lines the widget renders and the c=/r= values passed to the Kitty graphics protocol. The terminal scales the image to fit this cell rectangle.

Trait Implementations

impl Component for ImageWidget

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width.

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area.

fn handle_input(&mut self, _event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.).

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat.

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.