Struct ListView 

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

Rows drawn against a SelectionState, with the chrome every list pane in the UI puts around one: an optional border, an optional scrollbar, and a placeholder for when there is nothing to show.

Only the rows on screen are built, so the pickers that index a whole working tree cost a screenful of work per frame rather than one row per entry.

Rows are fitted to the columns actually left over here, so callers building them never work out how much the border, highlight symbol, and scrollbar take. Rendering records where the rows landed, so a later click can be hit-tested against the same area they were drawn into.

Implementations

impl<'a> ListView<'a>

pub fn new(rows: Vec<Line<'static>>, theme: &'a Theme) -> Self

Rows already in hand, for the lists short enough that building them all costs nothing.

pub fn lazy( len: usize, row: impl FnMut(usize) -> Line<'static> + 'a, theme: &'a Theme, ) -> Self

len rows, each built by row only if it is drawn.

pub fn empty_message(self, message: &'a str) -> Self

Shown in place of the rows when there are none.

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

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

Wraps the list in a titled border, the standard full-pane picker chrome.

pub fn pane(self, empty_message: &'a str) -> Self

pub fn scrollbar(self) -> Self

Reserves the rightmost column for a scrollbar, so the track never sits on top of the rows.

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

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

pub fn highlight_horizontal_padding(self, padding: u16) -> Self

Trait Implementations

impl StatefulWidget for ListView<'_>

type State = SelectionState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, selection: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.