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 calculating the correct offset to show a specific item will fail.

With this flag the row-height for each row is stored as part of the state.

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

Defines the direction how the items are displayed.

With bottom to top, the item at offset is rendered at the bottom of the area and moves up for the next items. Navigation with the arrow keys will also reverse and follows the screen directions.

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

Set the symbol to be displayed in front of the selected item. By default, there are no highlight symbol.

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

Separate style for the highlight symbol.

When no set the symbol uses the list-style and the select-style.

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

Set whether to repeat the highlight symbol and style over selected multi-line items. This is false by default.

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

Set when to show the highlight spacing

The highlight spacing is the spacing that is allocated for the selection symbol (if enabled) and is used to shift the list when an item is selected. This method allows you to configure when this spacing is allocated.

• HighlightSpacing::Always will always allocate the spacing, regardless of whether an item is selected or not. This means that the table will never change size, regardless of if an item is selected or not.
• HighlightSpacing::WhenSelected will only allocate the spacing if an item is selected. This means that the table will shift when an item is selected. This is the default setting for backwards compatibility, but it is recommended to use HighlightSpacing::Always for a better user experience.
• HighlightSpacing::Never will never allocate the spacing, regardless of whether an item is selected or not. This means that the highlight symbol will never be drawn.

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.