Struct DocumentWidget 

pub struct DocumentWidget<'a> { /* private fields */ }

Custom widget for rendering document content with proper text wrapping and inline images.

This widget handles the complete layout of document elements including:

• Text with unicode-aware wrapping
• Inline images with correct positioning
• Tables, lists, and other formatted content
• Search result highlighting

Unlike using the Paragraph widget with image overlays, this widget renders everything in a single pass with full control over layout, ensuring images are positioned correctly even when text wraps across multiple lines.

Implementations

impl<'a> DocumentWidget<'a>

pub fn new(elements: &'a [DocumentElement]) -> Self

Create a new DocumentWidget with the given document elements

pub fn scroll_offset(self, offset: usize) -> Self

Set the scroll offset (number of elements to skip from the top)

pub fn color_enabled(self, enabled: bool) -> Self

Enable or disable color rendering

pub fn search_results(self, results: &'a [SearchResult]) -> Self

Set search results for highlighting

pub fn current_search_index(self, index: usize) -> Self

Set the current search result index for highlighting

pub fn render( &mut self, area: Rect, frame: &mut Frame<'_>, image_protocols: &mut [StatefulProtocol], layout_cache: &mut LayoutCache, )

Custom render method that has access to Frame for complete rendering.

This method renders all document elements including text (with wrapping) and images. Unlike the Widget trait’s render method, this has access to Frame which is required for rendering StatefulImage widgets.