Struct CommandPalette 

pub struct CommandPalette { /* private fields */ }

Command palette widget for instant action search.

Provides a fuzzy-search overlay with keyboard navigation, match highlighting, and incremental scoring for responsive keystroke handling.

Invariants

1. selected is always < filtered.len() (or 0 when empty).
2. Results are sorted by descending score with stable tie-breaking.
3. Query changes trigger incremental re-scoring (not full rescan) when the query extends the previous one.

Implementations

impl CommandPalette

pub fn new() -> Self

Create a new empty command palette.

pub fn with_style(self, style: PaletteStyle) -> Self

Set the visual style (builder).

pub fn set_style(&mut self, style: PaletteStyle)

Set the visual style.

pub fn with_max_visible(self, n: usize) -> Self

Set max visible results (builder).

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

Set a custom title for the palette border (builder).

Defaults to " Command Palette ". The title is rendered centered in the top border. Surrounding spaces are the caller’s responsibility.

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

Set a custom title for the palette border.

pub fn with_fill_area(self, fill: bool) -> Self

Use the full area passed to render() instead of computing a centered sub-area (builder).

When true, the palette fills the entire Rect handed to Widget::render, letting the caller control position and size externally. When false (the default), the palette computes its own dimensions (~60 % width, centered, 1/6 from top).

pub fn set_fill_area(&mut self, fill: bool)

Set whether the palette should fill the entire render area.

pub fn enable_evidence_tracking(&mut self, enabled: bool)

Enable or disable evidence tracking for match results.

pub fn register( &mut self, title: impl Into<String>, description: Option<&str>, tags: &[&str], ) -> &mut Self

Register a new action.

pub fn register_action(&mut self, action: ActionItem) -> &mut Self

Register an action item directly.

pub fn replace_actions(&mut self, actions: Vec<ActionItem>)

Replace all actions with a new list.

This resets caches and refreshes the filtered results.

pub fn clear_actions(&mut self)

Clear all registered actions.

pub fn action_count(&self) -> usize

Number of registered actions.

pub fn open(&mut self)

Open the palette (show it and focus the query input).

pub fn close(&mut self)

Close the palette.

pub fn toggle(&mut self)

Toggle visibility.

pub fn is_visible(&self) -> bool

Whether the palette is currently visible.

pub fn query(&self) -> &str

Current query string.

pub fn set_query(&mut self, query: impl Into<String>)

Replace the query string and re-run filtering.

pub fn result_count(&self) -> usize

Number of filtered results.

pub fn selected_index(&self) -> usize

Currently selected index.

pub fn selected_action(&self) -> Option<&ActionItem>

Get the currently selected action, if any.

pub fn selected_match(&self) -> Option<PaletteMatch<'_>>

Read-only access to the selected match (action + result).

pub fn results(&self) -> impl Iterator<Item = PaletteMatch<'_>>

Iterate over the current filtered results.

pub fn set_match_filter(&mut self, filter: MatchFilter)

Set a match-type filter and refresh results.

pub fn scorer_stats(&self) -> &IncrementalStats

Get scorer statistics for diagnostics.

pub fn handle_event(&mut self, event: &Event) -> Option<PaletteAction>

Handle an input event. Returns a PaletteAction if the user executed or dismissed the palette.

Returns None if the event was consumed but no action was triggered, or if the palette is not visible.

Trait Implementations

impl Debug for CommandPalette

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CommandPalette

fn default() -> Self

Returns the “default value” for a type.

impl Widget for CommandPalette

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

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.