Struct ImageBuilder 

pub struct ImageBuilder { /* private fields */ }

Builder for Image views.

Implementations

impl ImageBuilder

pub fn new() -> Self

pub fn data(self, bytes: &[u8]) -> Self

Set the image data from raw bytes.

Supports PNG, JPEG, and GIF formats. Kitty auto-detects the format. GIF animations are handled natively by Kitty.

Example

View::image()
    .data(include_bytes!("logo.png"))
    .build()

pub fn file(self, path: impl Into<String>) -> Self

Set the image source from a file path.

The file is loaded at render time.

Example

View::image()
    .file("assets/animation.gif")
    .build()

Examples found in repository

examples/30_image.rs (line 49)

    fn render(&self, cx: Scope) -> View {
        let show_help = state!(cx, || false);

        // F1 toggles help
        cx.use_command(
            KeyBinding::key(KeyCode::F(1)),
            with!(show_help => move || show_help.update(|v| *v = !*v)),
        );
        View::vstack()
            .spacing(1)
            .child(
                View::styled_text("Image Widget Demo (Kitty Graphics)")
                    .bold()
                    .build(),
            )
            .child(View::text("Requires Kitty, Ghostty, or WezTerm terminal"))
            .child(View::text(""))
            // Load image from file path
            .child(View::text("Logo (from file path):"))
            .child(View::image().file("assets/telex-tui.png").build())
            .child(View::text(""))
            .child(View::styled_text("F1 help • Ctrl+Q quit").dim().build())
            .child(
                View::modal()
                    .visible(show_help.get())
                    .title("Example 30: Image")
                    .on_dismiss(with!(show_help => move || show_help.set(false)))
                    .child(
                        View::vstack()
                            .child(View::styled_text("What you're seeing").bold().build())
                            .child(View::text("• Image display via Kitty protocol"))
                            .child(View::text("• PNG/JPEG/GIF support"))
                            .child(View::text("• Loaded from file path"))
                            .child(View::gap(1))
                            .child(View::styled_text("Key concepts").bold().build())
                            .child(View::text("• View::image() displays images"))
                            .child(View::text("• .file(\"path\") loads from disk"))
                            .child(View::text("• .bytes(data) for embedded images"))
                            .child(View::text("• Works in Kitty/Ghostty/WezTerm"))
                            .child(View::gap(1))
                            .child(View::styled_text("Try this").bold().build())
                            .child(View::text("• Run in compatible terminal"))
                            .child(View::text("• See the Telex logo rendered"))
                            .child(View::gap(1))
                            .child(View::styled_text("Next up").bold().build())
                            .child(View::text("→ 31_animated_canvas: animations"))
                            .child(View::gap(1))
                            .child(View::styled_text("Press Escape to close").dim().build())
                            .build(),
                    )
                    .build(),
            )
            .build()
    }

pub fn width(self, cells: u16) -> Self

Set explicit width in terminal cells.

pub fn height(self, cells: u16) -> Self

Set explicit height in terminal cells.

pub fn id(self, id: u32) -> Self

Set a specific image ID (for manual caching control).

pub fn alt(self, text: impl Into<String>) -> Self

Set alt text for accessibility or fallback display.

pub fn build(self) -> View

Examples found in repository

examples/30_image.rs (line 49)

    fn render(&self, cx: Scope) -> View {
        let show_help = state!(cx, || false);

        // F1 toggles help
        cx.use_command(
            KeyBinding::key(KeyCode::F(1)),
            with!(show_help => move || show_help.update(|v| *v = !*v)),
        );
        View::vstack()
            .spacing(1)
            .child(
                View::styled_text("Image Widget Demo (Kitty Graphics)")
                    .bold()
                    .build(),
            )
            .child(View::text("Requires Kitty, Ghostty, or WezTerm terminal"))
            .child(View::text(""))
            // Load image from file path
            .child(View::text("Logo (from file path):"))
            .child(View::image().file("assets/telex-tui.png").build())
            .child(View::text(""))
            .child(View::styled_text("F1 help • Ctrl+Q quit").dim().build())
            .child(
                View::modal()
                    .visible(show_help.get())
                    .title("Example 30: Image")
                    .on_dismiss(with!(show_help => move || show_help.set(false)))
                    .child(
                        View::vstack()
                            .child(View::styled_text("What you're seeing").bold().build())
                            .child(View::text("• Image display via Kitty protocol"))
                            .child(View::text("• PNG/JPEG/GIF support"))
                            .child(View::text("• Loaded from file path"))
                            .child(View::gap(1))
                            .child(View::styled_text("Key concepts").bold().build())
                            .child(View::text("• View::image() displays images"))
                            .child(View::text("• .file(\"path\") loads from disk"))
                            .child(View::text("• .bytes(data) for embedded images"))
                            .child(View::text("• Works in Kitty/Ghostty/WezTerm"))
                            .child(View::gap(1))
                            .child(View::styled_text("Try this").bold().build())
                            .child(View::text("• Run in compatible terminal"))
                            .child(View::text("• See the Telex logo rendered"))
                            .child(View::gap(1))
                            .child(View::styled_text("Next up").bold().build())
                            .child(View::text("→ 31_animated_canvas: animations"))
                            .child(View::gap(1))
                            .child(View::styled_text("Press Escape to close").dim().build())
                            .build(),
                    )
                    .build(),
            )
            .build()
    }

Trait Implementations

impl Default for ImageBuilder

fn default() -> Self

Returns the “default value” for a type.