Struct List 

pub struct List<'a, Selection = RowSelection> { /* private fields */ }

List widget.

Fully compatible with ratatui List. Adds Scroll, selection models, and event-handling.

Implementations

impl<'a, Selection> List<'a, Selection>

pub fn new<T>(items: T) -> Self

where T: IntoIterator, T::Item: Into<ListItem<'a>>,

New list.

pub fn items<T>(self, items: T) -> Self

where T: IntoIterator, T::Item: Into<ListItem<'a>>,

Set items.

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

Border support.

pub fn scroll(self, scroll: Scroll<'a>) -> Self

Scroll support.

pub fn styles_opt(self, styles: Option<ListStyle>) -> Self

Set all styles.

pub fn styles(self, styles: ListStyle) -> Self

Set all styles.

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

Base style

pub fn select_style<S: Into<Style>>(self, select_style: S) -> Self

Select style.

pub fn focus_style<S: Into<Style>>(self, focus_style: S) -> Self

Focused style.

pub fn varying_heights(self, varying: bool) -> Self

If your list uses varying row-heights for each row all page calculations will fail (somewhat). If you enable this flag, the row-heights for each row will be stored in the state to allow accurate page-calculations.

pub fn direction(self, direction: ListDirection) -> Self

List direction.

pub fn highlight_symbol<L: Into<Line<'a>>>(self, highlight_symbol: L) -> Self

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

pub fn repeat_highlight_symbol(self, repeat: bool) -> Self

pub fn highlight_spacing(self, value: HighlightSpacing) -> Self

pub fn scroll_padding(self, padding: usize) -> Self

Sets the number of items around the currently selected item that should be kept visible.

pub fn len(&self) -> usize

Number of items.

pub fn is_empty(&self) -> bool

Empty?

pub fn width(&self) -> u16

Inherent width

pub fn height(&self) -> u16

Inherent height

Trait Implementations

impl<'a, Selection: Clone> Clone for List<'a, Selection>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, Selection: Debug> Debug for List<'a, Selection>

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

Formats the value using the given formatter.

impl<'a, Selection: Default> Default for List<'a, Selection>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Item, Selection> FromIterator<Item> for List<'a, Selection>

where Item: Into<ListItem<'a>>,

fn from_iter<Iter: IntoIterator<Item = Item>>(iter: Iter) -> Self

Creates a value from an iterator.

impl<Selection: ListSelection> StatefulWidget for List<'_, Selection>

type State = ListState<Selection>

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &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.