Struct List 

pub struct List<Msg> { /* private fields */ }

A vertical list that only draws the rows it shows, so it stays fast with any number of items. For a very long list, keep the items as an Arc<[ListItem]> in your state and pass it to List::shared, so they are not built again every frame.

The application owns the selection and the checked rows; the list reports changes through messages. Hovered and selected rows raise their surface, show the accent pillar and slide their icon and label one cell right. The pillar, the check mark of a multi-select list and the detail column never move, so a mark is always where the pointer left it.

Keys while focused: ↑/↓ or k/j move, Home/End and PgUp/PgDn jump, Enter activates, Space toggles in multi-select lists and activates otherwise. A click on a row selects and activates it; in a multi-select list a click on the check mark (or the cell after it) only toggles. Style keys: list-item with hover, selected, focus, pressed; list-item.faint, list-header, list-detail, scrollbar.

Implementations

impl<Msg: 'static> List<Msg>

pub fn new(items: impl IntoIterator<Item = ListItem>) -> Self

A list of items.

pub fn shared(items: Arc<[ListItem]>) -> Self

A list of items kept by the application, e.g. in its state: building the list in view only clones the Arc, however many items there are.

pub fn scrollbar(self, style: ScrollbarStyle) -> Self

Draws the scrollbar in style whatever the theme chooses.

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

The selected row index.

pub fn checked(self, checked: Vec<bool>) -> Self

Turns the list into a multi-select list; checked[i] tells whether row i is checked.

pub fn empty_text(self, text: impl Into<String>) -> Self

Text shown when there are no items.

pub fn on_select(self, message: impl Fn(usize) -> Msg + 'static) -> Self

Message for moving the selection to a row.

pub fn on_activate(self, message: impl Fn(usize) -> Msg + 'static) -> Self

Message for opening a row (Enter, click).

pub fn on_toggle(self, message: impl Fn(usize) -> Msg + 'static) -> Self

Message for checking or unchecking a row in a multi-select list (Space, click on the mark).

Trait Implementations

impl<Msg: 'static> Widget<Msg> for List<Msg>

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.