Struct CustomList 

pub struct CustomList<'a, T: AsWidget> { /* private fields */ }

A widget that displays a customizable list of items

Implementations

impl<'a, T: AsWidget> CustomList<'a, T>

pub fn new(style: impl Into<Style>, inline: bool, items: Vec<T>) -> Self

Creates a new CustomList

pub fn horizontal(self) -> Self

Sets the scroll axis to horizontal

pub fn vertical(self) -> Self

Sets the scroll axis to vertical (the default)

pub fn title(self, title: impl Into<Cow<'a, str>>) -> Self

Sets the title for the list

pub fn highlight_symbol(self, highlight_symbol: String) -> Self

Sets the symbol to be displayed before the selected item

pub fn highlight_symbol_mode( self, highlight_symbol_mode: HighlightSymbolMode, ) -> Self

Sets the rendering mode for the highlight symbol

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

Sets the style for the highlight symbol

pub fn set_title(&mut self, new_title: impl Into<Cow<'a, str>>)

Updates the title of the list

pub fn set_focus(&mut self, focus: bool)

Sets the focus state of the list

pub fn is_focused(&self) -> bool

Returns whether the text area is currently focused or not

pub fn len(&self) -> usize

Returns the number of items in this list

pub fn is_empty(&self) -> bool

Returns true if the list contains no items

pub fn items(&self) -> &Vec<T>

Returns a reference to the inner items of the list

pub fn items_mut(&mut self) -> &mut Vec<T>

Returns a mutable reference to the inner items of the list

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

Updates the items displayed in this list

pub fn reset_selection(&mut self)

Resets the internal selected state

pub fn select_next(&mut self)

Selects the next item in the list, wrapping around to the beginning if at the end.

pub fn select_prev(&mut self)

Selects the previous item in the list, wrapping around to the end if at the beginning.

pub fn select_first(&mut self)

Selects the first item in the list

pub fn select_last(&mut self)

Selects the last item in the list

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

Selects the given index

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

Returns the index of the currently selected item

pub fn selected_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the currently selected item

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

Returns a reference to the currently selected item

pub fn selected_with_index(&self) -> Option<(usize, &T)>

Returns a reference to the currently selected item and its index

pub fn delete_selected(&mut self) -> Option<T>

Deletes the currently selected item from the list and returns it

Trait Implementations

impl<'a, T: AsWidget> Widget for &mut CustomList<'a, T>

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

where Self: Sized,

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