Struct SelectableList

pub struct SelectableList<'b> { /* private fields */ }

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

Examples

SelectableList::default()
    .block(Block::default().title("SelectableList").borders(Borders::ALL))
    .items(&["Item 1", "Item 2", "Item 3"])
    .select(Some(1))
    .style(Style::default().fg(Color::White))
    .highlight_style(Style::default().modifier(Modifier::ITALIC))
    .highlight_symbol(">>");

Implementations

impl<'b> SelectableList<'b>

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

pub fn items<I>(self, items: &'b [I]) -> SelectableList<'b>

where I: AsRef<str> + 'b,

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

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

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

pub fn select(self, index: Option<usize>) -> SelectableList<'b>

Trait Implementations

impl<'b> Default for SelectableList<'b>

fn default() -> SelectableList<'b>

Returns the “default value” for a type.

impl<'b> Widget for SelectableList<'b>

fn draw(&mut 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.

fn background(&self, area: Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, f: &mut Frame<'_, B>, area: Rect)

where Self: Sized, B: Backend,

Helper method that can be chained with a widget’s builder methods to render it.