Struct List 

pub struct List<'a, C: PixelColor, M: Clone> { /* private fields */ }

Styled, scrollable vertical list of selectable rows.

Build it with List::new, add rows via List::item, List::item_with, or List::push, then enable scrolling with the same builders a Column exposes. A tapped row emits the List::on_select message carrying its zero-based index.

Implementations

impl<'a, C: PixelColor + 'a, M: Clone + 'a> List<'a, C, M>

pub fn new() -> Self

Create a new empty list. Position and size are assigned by the parent via arrange. Defaults to filling its container with 0 px spacing between rows.

pub fn width(self, width: impl Into<Length>) -> Self

Width sizing intent.

pub fn height(self, height: impl Into<Length>) -> Self

Height sizing intent.

pub fn id(self, id: WidgetId) -> Self

Set a stable base id so rows can participate in focus traversal.

pub fn spacing(self, spacing: u32) -> Self

Gap (px) between rows. Defaults to 0 (rows abut, suited to dividers).

pub fn dividers(self, on: bool) -> Self

Draw a thin divider under every row.

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

Index of the row to render with the selected highlight. Host-driven — typically the value the last List::on_select set.

pub fn on_select<F>(self, f: F) -> Self

where F: Fn(usize) -> M + 'a,

Callback invoked with a tapped row’s index. Without it the rows are inert (they still draw, but emit no message).

pub fn item(self, label: impl Into<String>) -> Self

Append a row showing a single label.

pub fn item_with( self, leading: Option<impl Into<String>>, label: impl Into<String>, trailing: Option<impl Into<String>>, ) -> Self

Append a row with an optional leading slot (e.g. an icon glyph), a main label, and an optional trailing slot (e.g. an accessory glyph or value text). Pass ""/None for slots you don’t need.

pub fn push(self, row: ListRow<'a, C, M>) -> Self

Append a pre-built ListRow. The row’s index is reassigned to its position in the list, and the list-wide divider/select settings are applied at layout time.

pub fn scrollable(self, dir: ScrollDirection) -> Self

Make this list scrollable on dir. Mirrors Column::scrollable. Lists are vertical, so ScrollDirection::Vertical is the usual choice.

pub fn scroll_state(self, state: &ScrollState) -> Self

Supply the host-owned ScrollState read this frame. Implies scrolling (vertical by default). Mirrors Column::scroll_state.

pub fn scrollbar(self, mode: ScrollbarMode) -> Self

When the scrollbar is drawn. Mirrors Column::scrollbar.

pub fn snap(self, mode: SnapMode) -> Self

Snapping mode. Mirrors Column::snap.

pub fn on_scroll<F>(self, f: F) -> Self

where F: Fn(ScrollMsg) -> M + 'a,

Callback mapping a ScrollMsg to the host message. Mirrors Column::on_scroll.

Trait Implementations

impl<'a, C: PixelColor + 'a, M: Clone + 'a> Default for List<'a, C, M>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, C: PixelColor + 'a, M: Clone + 'a> Widget<C, M> for List<'a, C, M>

fn measure(&mut self, constraints: Constraints) -> Size

Report the size this widget wants within constraints.

fn preferred_size(&self) -> (Length, Length)

Per-axis sizing intent set via .width(...) / .height(...). Containers consult this during layout to allocate fixed slots, query intrinsic sizes, and split residual space among Fill / FillPortion children. Default is Length::Fill on both axes.

fn arrange(&mut self, rect: Rectangle)

Commit the final rectangle, recursively arranging any children.

fn rect(&self) -> Rectangle

The current arranged rectangle.

fn handle_touch(&mut self, point: Point, phase: TouchPhase) -> Option<M>

Dispatch a touch event. Returns a message if consumed.

fn mark_pressed(&mut self, point: Point)

Set this widget’s pressed flag if point hits. No message emit. Containers forward to children. Default no-op.

fn draw<'t>( &self, renderer: &mut dyn Renderer<C>, theme: &Theme<'t, C>, ) -> Result<(), RenderError>

Paint into renderer at rect.

fn widget_id(&self) -> Option<WidgetId>

Stable id of this widget, if it participates in focus.

fn is_focusable(&self) -> bool

True if this widget should appear in focus traversal.

fn collect_focusable(&self, out: &mut Vec<WidgetId>)

Append focusable widget ids in traversal order.

fn sync_focus(&mut self, focused: Option<WidgetId>)

Synchronize focused state against the runtime’s currently-focused id.

fn handle_action(&mut self, action: UiAction) -> Option<M>

Handle a semantic action directed at this widget.

fn route_action(&mut self, target: WidgetId, action: UiAction) -> Option<M>

Route a semantic action to the widget with id target.

fn navigate_focus(&self, target: WidgetId, action: UiAction) -> Option<WidgetId>

Request a focus movement relative to target for directional actions.

fn focus_rect(&self, target: WidgetId) -> Option<Rectangle>

Rectangle currently occupied by the focusable target, if any.

fn focus_at(&self, point: Point) -> Option<WidgetId>

Focusable widget id at point, if any.