Struct List

pub struct List<'a, T: PreRender> {
    pub items: Vec<T>,
    /* private fields */
}

👎Deprecated since 0.11.0: Use ListView with ListBuilder instead.

A List is a widget for Ratatui that can render an arbitrary list of widgets. It is generic over T, where each widget T should implement the PreRender trait. List is no longer developed. Consider using ListView.

Fields

items: Vec<T>

👎Deprecated since 0.11.0: Use ListView with ListBuilder instead.

The list’s items.

Implementations

impl<'a, T: PreRender> List<'a, T>

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

Instantiates a widget list with elements.

Arguments

• items - A vector of elements implementing the PreRender trait.

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

Sets the block style that surrounds the whole List.

pub fn is_empty(&self) -> bool

Checks whether the widget list is empty.

pub fn len(&self) -> usize

Returns the length of the widget list.

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

Set the base style of the List.

pub fn scroll_direction(self, scroll_axis: ScrollAxis) -> Self

Set the scroll direction of the list.

Trait Implementations

impl<'a, T: Clone + PreRender> Clone for List<'a, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PreRender> From<Vec<T>> for List<'_, T>

fn from(items: Vec<T>) -> Self

Instantiates a List from a vector of elements implementing the PreRender trait.

impl<T: PreRender> StatefulWidget for List<'_, T>

type State = ListState

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.

impl<T: PreRender> Styled for List<'_, T>

type Item = List<'_, T>

fn style(&self) -> Style

Returns the style of the object.

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

Sets the style of the object.