Struct tui::widgets::List

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

A widget to display several items among which one can be selected (optional)

Examples

let items = [ListItem::new("Item 1"), ListItem::new("Item 2"), ListItem::new("Item 3")];
List::new(items)
    .block(Block::default().title("List").borders(Borders::ALL))
    .style(Style::default().fg(Color::White))
    .highlight_style(Style::default().add_modifier(Modifier::ITALIC))
    .highlight_symbol(">>");

Implementations

impl<'a> List<'a>

pub fn new<T>(items: T) -> List<'a> where
    T: Into<Vec<ListItem<'a>>>, 

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

pub fn style(self, style: Style) -> List<'a>

pub fn highlight_symbol(self, highlight_symbol: &'a str) -> List<'a>

pub fn highlight_style(self, style: Style) -> List<'a>

pub fn start_corner(self, corner: Corner) -> List<'a>

Trait Implementations

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

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

Returns a copy of the value.

pub 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> StatefulWidget for List<'a>

type State = ListState

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

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

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

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