Struct List 

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

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")];
let mut list = List::new(items);
list.block(Block::default().title("List").borders(Borders::ALL));
list.style(Style::default().fg(Color::White));
list.highlight_style(Style::default().add_modifier(Modifier::ITALIC));
list.highlight_symbol(">>");

Implementations

impl<'a> List<'a>

pub fn new<T>(items: T) -> List<'a>

where T: Into<Vec<ListItem<'a>>>,

pub fn block(&mut self, block: Block<'a>)

pub fn style(&mut self, style: Style)

pub fn highlight_symbol(&mut self, highlight_symbol: &'a str)

pub fn highlight_style(&mut self, style: Style)

pub fn repeat_highlight_symbol(&mut self, repeat: bool)

pub fn start_corner(&mut self, corner: Corner)

pub fn selected(&self) -> Option<usize>

pub fn select(&mut self, index: Option<usize>)

pub fn update_items<T>(&mut self, items: T)

where T: Into<Vec<ListItem<'a>>>,

Trait Implementations

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

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

Returns a duplicate of the value.

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

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

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