Struct List 

pub struct List<I: Item, D: ItemDelegate<I>> {

    pub title: String,
    pub show_title: bool,
    pub show_filter: bool,
    pub show_status_bar: bool,
    pub show_pagination: bool,
    pub show_help: bool,
    pub filtering_enabled: bool,
    pub infinite_scrolling: bool,
    pub item_name_singular: String,
    pub item_name_plural: String,
    pub key_map: KeyMap,
    pub styles: Styles,
    pub status_message_lifetime: Duration,
    pub mouse_wheel_enabled: bool,
    pub mouse_wheel_delta: usize,
    pub mouse_click_enabled: bool,
    /* private fields */
}

List model with filtering, pagination, and more.

Fields

title: String

Title of the list.

show_title: bool

Whether to show the title.

show_filter: bool

Whether to show the filter input.

show_status_bar: bool

Whether to show the status bar.

show_pagination: bool

Whether to show pagination.

show_help: bool

Whether to show help.

filtering_enabled: bool

Whether filtering is enabled.

infinite_scrolling: bool

Whether infinite scrolling is enabled.

item_name_singular: String

Singular name for items.

item_name_plural: String

Plural name for items.

key_map: KeyMap

Key bindings.

styles: Styles

Styles.

status_message_lifetime: Duration

Status message lifetime.

mouse_wheel_enabled: bool

Whether mouse wheel scrolling is enabled.

mouse_wheel_delta: usize

Number of items to scroll per mouse wheel tick.

mouse_click_enabled: bool

Whether mouse click selection is enabled.

Implementations

impl<I: Item, D: ItemDelegate<I>> List<I, D>

pub fn new(items: Vec<I>, delegate: D, width: usize, height: usize) -> Self

Creates a new list with the given items and delegate.

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

Sets the title.

pub fn mouse_wheel(self, enabled: bool) -> Self

Enables or disables mouse wheel scrolling (builder pattern).

pub fn mouse_wheel_delta(self, delta: usize) -> Self

Sets the number of items to scroll per mouse wheel tick (builder pattern).

pub fn mouse_click(self, enabled: bool) -> Self

Enables or disables mouse click item selection (builder pattern).

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

Sets the items.

pub fn items(&self) -> &[I]

Returns the items.

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

Returns visible items based on current filter.

pub fn index(&self) -> usize

Returns the current cursor index in the filtered list.

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

Returns the currently selected item.

pub fn select(&mut self, index: usize)

Selects an item by index.

pub fn cursor_up(&mut self)

Moves the cursor up.

pub fn cursor_down(&mut self)

Moves the cursor down.

pub fn filter_state(&self) -> FilterState

Returns the filter state.

pub fn filter_value(&self) -> String

Returns the current filter value.

pub fn set_filter_value(&mut self, value: &str)

Sets the filter value.

pub fn reset_filter(&mut self)

Resets the filter.

pub fn start_spinner(&mut self) -> Option<Message>

Starts the spinner. Returns a message that should be passed to update to start the animation.

pub fn stop_spinner(&mut self)

Stops the spinner.

pub fn spinner_visible(&self) -> bool

Returns whether the spinner is visible.

pub fn new_status_message(&mut self, msg: impl Into<String>) -> Option<Cmd>

Sets a new status message.

pub fn status_message(&self) -> Option<&str>

Returns the current status message.

pub fn set_width(&mut self, w: usize)

Sets the width.

pub fn set_height(&mut self, h: usize)

Sets the height.

pub fn width(&self) -> usize

Returns the width.

pub fn height(&self) -> usize

Returns the height.

pub fn paginator(&self) -> &Paginator

Returns a reference to the paginator.

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

Updates the list based on messages.

pub fn view(&self) -> String

Renders the list.

pub fn init(&self) -> Option<Cmd>

Initializes the list (called when used as a standalone Model).

Returns None by default since lists are typically initialized with items. Override or use start_spinner() if loading items asynchronously.

Trait Implementations

impl<I: Clone + Item, D: Clone + ItemDelegate<I>> Clone for List<I, D>

fn clone(&self) -> List<I, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Item + Debug, D: ItemDelegate<I> + Debug> Debug for List<I, D>

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

Formats the value using the given formatter.

impl<I: Item, D: ItemDelegate<I>> Model for List<I, D>

Implement the Model trait for standalone bubbletea usage.

fn init(&self) -> Option<Cmd>

Initialize the model and return an optional startup command.

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

Process a message and return a new command.

fn view(&self) -> String

Render the model as a string for display.