Struct ChatView 

pub struct ChatView { /* private fields */ }

Chat message display widget with streaming and tool execution support.

Implementations

impl ChatView

pub fn new() -> Self

Create a new ChatView with default settings

pub fn with_config(config: ChatViewConfig) -> Self

Create a new ChatView with custom configuration

pub fn config(&self) -> &ChatViewConfig

Get the current configuration

pub fn set_config(&mut self, config: ChatViewConfig)

Set a new configuration

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title displayed in the title bar

pub fn with_initial_content(self, render: RenderFn) -> Self

Set custom initial content renderer (shown when no messages)

Provide a closure for full ratatui control over what to display when the chat has no messages yet.

pub fn with_title_renderer<F>(self, render: F) -> Self

where F: Fn(&str, &Theme) -> (Line<'static>, Line<'static>) + Send + Sync + 'static,

Set custom title bar renderer

The function receives the current title and theme, and returns (left_title, right_title) as ratatui Lines.

pub fn set_title(&mut self, title: impl Into<String>)

Set the title displayed in the title bar (mutable setter)

pub fn title(&self) -> &str

Get the current title

pub fn step_spinner(&mut self)

Advance the spinner animation

pub fn add_user_message(&mut self, content: String)

Add a user message (does not force scroll - caller should handle that)

pub fn add_assistant_message(&mut self, content: String)

Add an assistant message (complete)

pub fn add_system_message(&mut self, content: String)

Add a system message (ignores empty messages)

pub fn add_tool_message( &mut self, tool_use_id: &str, display_name: &str, display_title: &str, )

Add a tool execution message

pub fn update_tool_status(&mut self, tool_use_id: &str, status: ToolStatus)

Update a tool message status by tool_use_id - O(1) lookup

pub fn enable_auto_scroll(&mut self)

Re-enable auto-scroll and scroll to bottom (call when user submits a message)

pub fn append_streaming(&mut self, text: &str)

Append text to the streaming buffer

pub fn complete_streaming(&mut self)

Complete the streaming response and add as assistant message

pub fn discard_streaming(&mut self)

Discard the streaming buffer without saving (used on cancel)

pub fn is_streaming(&self) -> bool

Check if currently streaming

pub fn scroll_up(&mut self)

pub fn scroll_down(&mut self)

pub fn render_chat( &mut self, frame: &mut Frame<'_>, area: Rect, pending_status: Option<&str>, )

Trait Implementations

impl ConversationView for ChatView

fn add_user_message(&mut self, content: String)

Add a user message to the conversation

fn add_assistant_message(&mut self, content: String)

Add an assistant message to the conversation

fn add_system_message(&mut self, content: String)

Add a system message to the conversation

fn append_streaming(&mut self, text: &str)

Append text to the current streaming response

fn complete_streaming(&mut self)

Complete the streaming response and finalize it as a message

fn discard_streaming(&mut self)

Discard the streaming buffer without saving (used on cancel)

fn is_streaming(&self) -> bool

Check if currently streaming a response

fn add_tool_message( &mut self, tool_use_id: &str, display_name: &str, display_title: &str, )

Add a tool execution message

fn update_tool_status(&mut self, tool_use_id: &str, status: ToolStatus)

Update the status of a tool message

fn scroll_up(&mut self)

Scroll up by the implementation’s scroll step

fn scroll_down(&mut self)

Scroll down by the implementation’s scroll step

fn enable_auto_scroll(&mut self)

Enable auto-scroll and scroll to bottom (called when user submits a message)

fn render( &mut self, frame: &mut Frame<'_>, area: Rect, _theme: &Theme, pending_status: Option<&str>, )

Render the conversation view

fn step_spinner(&mut self)

Advance the spinner animation (called periodically during activity)

fn save_state(&self) -> Box<dyn Any + Send>

Save the current state for session switching

fn restore_state(&mut self, state: Box<dyn Any + Send>)

Restore state from a previously saved state

fn clear(&mut self)

Clear conversation content while preserving configuration

impl Default for ChatView

fn default() -> Self

Returns the “default value” for a type.

impl Widget for ChatView

fn id(&self) -> &'static str

Unique identifier for this widget type

fn priority(&self) -> u8

Priority for key event handling (higher = checked first)

fn is_active(&self) -> bool

Whether the widget is currently active/visible

fn handle_key( &mut self, _key: KeyEvent, _ctx: &WidgetKeyContext<'_>, ) -> WidgetKeyResult

Handle key event, return result indicating what action to take.

fn render(&mut self, frame: &mut Frame<'_>, area: Rect, _theme: &Theme)

Render the widget

fn required_height(&self, _available: u16) -> u16

Calculate required height for this widget

fn blocks_input(&self) -> bool

Whether this widget blocks input to the text input when active

fn is_overlay(&self) -> bool

Whether this widget is a full-screen overlay

fn as_any(&self) -> &dyn Any

Cast to Any for downcasting

fn as_any_mut(&mut self) -> &mut dyn Any

Cast to Any for mutable downcasting

fn into_any(self: Box<Self>) -> Box<dyn Any>

Convert to Box<dyn Any> for owned downcasting