# tui-widget-list
## A versatile list implementation for Ratatui
This crate offers a stateful widget list implementation [`List`] for `Ratatui` that allows to work
with any list of widgets that implement the [`Listable`] trait. The associated selection state
is [`ListState`] which offers methods like next and previous.
### Examples
```rust
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::style::{Color, Style, Stylize};
use ratatui::text::Text;
use ratatui::widgets::{Paragraph, Widget};
use ratatui::Frame;
use tui_widget_list::{List, ListState, Listable};
#[derive(Debug, Clone)]
pub struct CustomItem {
text: String,
style: Style,
height: usize,
}
impl CustomItem {
pub fn new<T: Into<String>>(text: T, height: usize) -> Self {
Self {
text: text.into(),
style: Style::default(),
height,
}
}
}
impl Listable for CustomItem {
fn height(&self) -> usize {
self.height
}
fn highlight(self) -> Self {
Self {
style: self.style.reversed(),
..self
}
}
}
impl Widget for CustomItem {
fn render(self, area: Rect, buf: &mut Buffer) {
Paragraph::new(Text::from(self.text))
.style(self.style)
.render(area, buf);
}
}
pub fn render(f: &mut Frame) {
let list = List::new(vec![
CustomItem::new("hello", 1),
CustomItem::new("world", 2),
]);
let mut state = ListState::default();
f.render_stateful_widget(list, f.size(), &mut state);
}
```
For more examples see [tui-widget-list](https://github.com/preiter93/tui-widget-list/tree/main/examples).
### Configuration
The appearance of [`List`] can be modified
- **style**: The base style of the list.
- **block**: An optional outer block around the list.
- **truncate**: If truncate is true, the first and last elements are truncated to fill the entire screen. True by default.
The behaviour of [`ListState`] can be modified
- **circular**: Whether the selection is circular, i.e. if true, the first item is selected after the last. True by default.
License: MIT