Struct List 

pub struct List<'a> { /* private fields */ }

A widget to display a list of items.

Implementations

impl<'a> List<'a>

pub fn new(items: impl IntoIterator<Item = impl Into<ListItem<'a>>>) -> Self

Create a new list from the given items.

pub fn data_hash(self, hash: u64) -> Self

Set an explicit data hash to enable caching of filtered indices.

This is highly recommended for large lists. When provided, the list widget will cache the result of filtering in the ListState, skipping expensive O(N) string processing on frames where the hash and filter query have not changed.

pub fn block(self, block: Block<'a>) -> Self

Wrap the list in a decorative block.

pub fn style(self, style: Style) -> Self

Set the base style for the list area.

pub fn highlight_style(self, style: Style) -> Self

Set the style applied to the selected item.

pub fn hover_style(self, style: Style) -> Self

Set the style applied to the hovered item (mouse move).

pub fn highlight_symbol(self, symbol: &'a str) -> Self

Set a symbol displayed before the selected item.

pub fn hit_id(self, id: HitId) -> Self

Set a hit ID for mouse interaction.

When set, each list item will register a hit region with the frame’s hit grid (if enabled). The hit data will be the item’s index, allowing click handlers to determine which item was clicked.

pub fn handle_key(&self, state: &mut ListState, key: &KeyEvent) -> bool

Handle keyboard navigation and incremental filtering for this list.

Supported keys:

• Navigation: Up/Down, k/j (vi-style, always navigate — never appended to the filter query)
• Incremental filter input: printable chars (except j/k)
• Filter editing: Backspace, Escape
• Multi-select toggle (when enabled): Space

Trait Implementations

impl Accessible for List<'_>

fn accessibility_nodes(&self, area: Rect) -> Vec<A11yNodeInfo>

Return accessibility node(s) for this widget at the given bounds.

impl<'a> Clone for List<'a>

fn clone(&self) -> List<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for List<'a>

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

Formats the value using the given formatter.

impl<'a> Default for List<'a>

fn default() -> List<'a>

Returns the “default value” for a type.

impl MeasurableWidget for List<'_>

fn measure(&self, available: Size) -> SizeConstraints

Measure the widget given available space.

fn has_intrinsic_size(&self) -> bool

Quick check: does this widget have content-dependent sizing?

impl<'a> StatefulWidget for List<'a>

type State = ListState

The state type associated with this widget.

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

Render the widget into the frame, potentially modifying state.

impl<'a> Widget for List<'a>

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.