Struct tui::widgets::List

pub struct List<'b, L> where
    L: Iterator<Item = Text<'b>>,  { /* fields omitted */ }

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

Examples

let items = ["Item 1", "Item 2", "Item 3"].iter().map(|i| Text::raw(*i));
List::new(items)
    .block(Block::default().title("List").borders(Borders::ALL))
    .style(Style::default().fg(Color::White))
    .highlight_style(Style::default().modifier(Modifier::ITALIC))
    .highlight_symbol(">>");

Implementations

impl<'b, L> List<'b, L> where
    L: Iterator<Item = Text<'b>>, 

pub fn new(items: L) -> List<'b, L>

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

pub fn items<I>(self, items: I) -> List<'b, L> where
    I: IntoIterator<Item = Text<'b>, IntoIter = L>, 

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

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

pub fn highlight_style(self, highlight_style: Style) -> List<'b, L>

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

Trait Implementations

impl<'b, L: Clone> Clone for List<'b, L> where
    L: Iterator<Item = Text<'b>>, 

fn clone(&self) -> List<'b, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'b, L: Debug> Debug for List<'b, L> where
    L: Iterator<Item = Text<'b>>, 

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

Formats the value using the given formatter.

impl<'b, L> Default for List<'b, L> where
    L: Iterator<Item = Text<'b>> + Default, 

fn default() -> List<'b, L>

Returns the "default value" for a type.

impl<'b, L> StatefulWidget for List<'b, L> where
    L: Iterator<Item = Text<'b>>, 

type State = ListState

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

impl<'b, L> Widget for List<'b, L> where
    L: Iterator<Item = Text<'b>>, 

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.