Struct SelectList 

pub struct SelectList { /* private fields */ }

SelectList component.

Implementations

impl SelectList

pub fn new(items: Vec<SelectItem>, max_visible: usize) -> Self

Create a new select list.

pub fn with_theme( items: Vec<SelectItem>, max_visible: usize, theme: SelectListTheme, ) -> Self

Create a select list with a theme.

pub fn set_layout(&mut self, layout: SelectListLayoutOptions)

Override the primary/description column layout. The session picker uses this to widen the primary column so a preview is not clipped to the 32-column default.

pub fn new_multi(items: Vec<SelectItem>, max_visible: usize) -> Self

Create a selector that permits selecting several options with Space before submitting with Enter. Existing single-select selectors should continue using Self::new.

pub fn is_multi_select(&self) -> bool

Whether this list is in multi-select mode.

pub fn on_multi_select( &self, callback: Arc<dyn Fn(&[SelectItem]) + Send + Sync>, )

Set a callback invoked with all toggled options when Enter is pressed.

pub fn get_selected_items(&self) -> Vec<SelectItem>

Return the currently toggled options, preserving the source order.

pub fn toggle_selected(&self)

Toggle the currently highlighted option. No-op for a regular selector.

pub fn set_filter(&self, filter: &str)

Set the filter text.

pub fn set_selected_index(&self, index: usize)

Set the selected index.

pub fn get_selected_item(&self) -> Option<SelectItem>

Get the selected item.

pub fn on_select(&self, callback: Arc<dyn Fn(&SelectItem) + Send + Sync>)

Set callback for when an item is selected.

pub fn on_cancel(&self, callback: Arc<dyn Fn() + Send + Sync>)

Set callback for when cancelled.

pub fn on_selection_change( &self, callback: Arc<dyn Fn(&SelectItem) + Send + Sync>, )

Set callback for when selection changes.

pub fn handle_key(&self, key: KeyEvent)

Handle key input.

Trait Implementations

impl Component for SelectList

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

Render the component to lines for the given viewport width.

fn invalidate(&self)

Invalidate any cached rendering state. Called when theme changes or when component needs to re-render from scratch.

fn as_any(&self) -> &dyn Any

Downcast to Any for runtime type checking. This enables the layout system to check for LayoutNodeProvider.

fn handle_input(&self, _data: &str) -> bool

Optional handler for keyboard input when component has focus.

fn wants_key_release(&self) -> bool

If true, component receives key release events (Kitty protocol). Default is false - release events are filtered out.