Struct Model

pub struct Model<I: Item> {
    pub title: String,
    pub filter_input: Model,
    pub paginator: Model,
    pub spinner: Model,
    pub help: Model,
    pub keymap: ListKeyMap,
    pub styles: ListStyles,
    /* private fields */
}

List model containing items, filtering, pagination, and styling.

Fields

title: String

Title rendered in the list header when not filtering.

filter_input: Model

Text input used for entering the filter term.

paginator: Model

Paginator controlling visible item slice.

spinner: Model

Spinner used during expensive operations (optional usage).

help: Model

Help model for displaying key bindings.

keymap: ListKeyMap

Key bindings for list navigation and filtering.

styles: ListStyles

Visual styles for list elements and states.

Implementations

impl<I: Item + Send + Sync + 'static> Model<I>

pub fn new( items: Vec<I>, delegate: impl ItemDelegate<I> + Send + Sync + 'static, width: usize, height: usize, ) -> Self

Creates a new list with items, delegate, and initial dimensions.

pub fn set_items(&mut self, items: Vec<I>)

Replace all items in the list and reset pagination if needed.

pub fn visible_items(&self) -> Vec<I>

Returns a copy of the items currently visible (filtered if applicable).

pub fn set_filter_text(&mut self, s: &str)

Sets the filter input text.

pub fn set_filter_state(&mut self, st: FilterState)

Sets the current filtering state.

pub fn set_status_bar_item_name(&mut self, singular: &str, plural: &str)

Sets the singular/plural nouns used in the status bar.

pub fn status_view(&self) -> String

Renders the status bar string, including position and help.

pub fn matches_for_original_item( &self, original_index: usize, ) -> Option<&Vec<usize>>

Get matches for an item by its original index in the full items list. Returns None if the item doesn’t have matches (unfiltered or didn’t match filter).

pub fn with_title(self, title: &str) -> Self

Sets the list title and returns self for chaining.

pub fn selected_item(&self) -> Option<&I>

Returns a reference to the currently selected item, if any.

pub fn cursor(&self) -> usize

Returns the current cursor position (0-based).

pub fn len(&self) -> usize

Returns the number of items in the current view (filtered or not).

pub fn is_empty(&self) -> bool

Returns true if there are no items to display.

Trait Implementations

impl<I: Item> KeyMap for Model<I>

fn short_help(&self) -> Vec<&Binding>

Returns a slice of key bindings for the short help view.

fn full_help(&self) -> Vec<Vec<&Binding>>

Returns a nested slice of key bindings for the full help view. Each inner slice represents a column in the help view.

impl<I: Item + Send + Sync + 'static> Model for Model<I>

fn init() -> (Self, Option<Cmd>)

Initialize the model with its initial state and optional startup command.

fn update(&mut self, msg: Msg) -> Option<Cmd>

Update the model in response to a received message.

fn view(&self) -> String

Render the current model state as a string for terminal display.