Struct itui::widgets::SelectableList

pub struct SelectableList<'b, MSG> {
    pub events: Vec<Attribute<Event, MSG>>,
    // some fields omitted
}

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(">>");

Fields

events: Vec<Attribute<Event, MSG>>

events attached to this block

Methods

impl<'b, MSG> SelectableList<'b, MSG>

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

pub fn items<I>(self, items: &'b [I]) -> Self where
    I: AsRef<str> + 'b, 

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

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

pub fn highlight_style(self, highlight_style: Style) -> Self

pub fn select(self, index: Option<usize>) -> Self

Trait Implementations

impl<'b, MSG> Widget for SelectableList<'b, MSG> where
    MSG: Clone + 'static, 

fn get_area(&self) -> Rect

fn draw(&mut self, 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, 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>) where
    Self: Sized,
    B: Backend, 

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

fn top(&self) -> u16

fn bottom(&self) -> u16

fn left(&self) -> u16

fn right(&self) -> u16

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

fn default() -> Self

Returns the "default value" for a type.