Struct HelpOverlay 

pub struct HelpOverlay { /* private fields */ }

Help overlay showing available commands and keybindings.

Implementations

impl HelpOverlay

pub fn new(theme: &RabTheme) -> Self

pub fn set_commands(&mut self, commands: Vec<(String, String)>)

Trait Implementations

impl Component for HelpOverlay

fn render(&self, width: usize) -> Vec<String>

Render to lines for the given viewport width. Each returned string MUST NOT exceed width in visible width.

fn handle_input(&mut self, _key: &KeyEvent) -> bool

Handle keyboard input. Return true if consumed.

fn handle_paste(&mut self, _text: &str)

Handle a paste event (text from bracketed paste mode). Default no-op; override to process pasted content.

fn invalidate(&mut self)

Mark this component as needing re-render. Called when internal state changes (output received, expanded toggled, etc.).

fn is_dirty(&self) -> bool

Check if this component needs re-render. Default: always re-render (conservative).

fn clear_dirty(&mut self)

Clear dirty flag after successful render.

fn cache_key(&self, _width: usize) -> Option<RenderCacheKey>

Get the cache key for this component’s current state. Return None to disable caching (always re-render).

fn get_cached_render(&self) -> Option<&RenderCache>

Get cached render output, if available and valid.

fn set_cached_render(&mut self, _cache: RenderCache)

Store render output in cache.

fn is_focusable(&self) -> bool

Whether this component wants focus (for IME cursor positioning).

fn set_expanded(&mut self, _expanded: bool)

Toggle expanded/collapsed state. No-op by default. Override for components that support expand/collapse (tool results, messages, etc.).

fn set_hide_thinking(&mut self, _hide: bool)

Toggle thinking block visibility. No-op by default. Override for components that display thinking content (AssistantMessageComponent).