Struct VirtualListProps 

pub struct VirtualListProps {

    pub name: Option<String>,
    pub selection_follows_focus: bool,
    pub in_column: bool,
    pub transcript: bool,
    pub page_column: bool,
    pub tail_title: Option<String>,
    pub tree: bool,
    pub ungrouped_title: Option<String>,
    pub multi_select: bool,
    pub unread: Option<ResourceId>,
    pub rows: DescribedRows,
    pub removed: RemovedRows,
    pub selection: Option<Vec<String>>,
    pub chosen: Option<Vec<ResourceId>>,
    pub scroll: Option<f64>,
    pub open: Option<ResourceId>,
    pub motion: Option<Feel>,
    pub select: Event,
    pub activate: Event,
    pub selected: Event,
    pub opened: Event,
    pub closed: Event,
}

A long list of rows that costs only the rows on screen: each is built when it scrolls into view. Selection follows the person’s choice and is reported with the item it shows; the list is one focus stop.

Fields

name: Option<String>

What the list is, for assistive technology.

selection_follows_focus: bool

Moving through the rows with the keyboard selects them, as a list whose selection shows beside it does; a click or a tap on a row then activates it, as choosing an entry of an overview does.

in_column: bool

The list is a column’s whole body: its rows’ text starts where the column’s header starts its title.

transcript: bool

A conversation: each row stands in the page column, the list opens at its newest row and follows it.

page_column: bool

Each row stands in the page column, at the readable measure every page sets its blocks on, a section’s gap under the row before it. A list read from its first row to its last (a conversation’s messages, a document’s replies) keeps the measure without following its end as a transcript does.

tail_title: Option<String>

The title over the list’s tail group: the rows whose item says it is one of those done with (ListItemProps::tail) stand after every group, under it, closed until the person opens them. None leaves those rows among the others.

tree: bool

The rows stand as a tree: each indented under the row of the item it names as its parent (ListItemProps::parent), with a disclosure on the rows that have subtasks, folding them away. The list works the tree out of the items as it builds their rows.

ungrouped_title: Option<String>

The title over the group of rows whose item names no group: a list grouped by a thing some items lack (a day, a place) heads those rows with it, never folding them under the last group that names one. The rows keep the order their list gives. None leaves them among the others.

multi_select: bool

The list holds more than one selected row: a click with ctrl (or cmd) adds or takes away the row it lands on, one with shift takes the range from the last row chosen, and Escape puts the selection away. Without it a click chooses the one row the window shows.

unread: Option<ResourceId>

The item a conversation’s reader had not seen when they opened it (first_unseen(c)): the “New messages” divider stands over the row that shows it, and while that is above the view a pill at the foot offers to take the reader back to it. None draws neither. The list works out the row as it builds, so the same list keeps its rows and only the two the divider moved between build again.

rows: DescribedRows

The items, in order.

removed: RemovedRows

Items someone else removed that the person has not seen go: each a row after the items, its title struck through. The UI host places them.

selection: Option<Vec<String>>

The selected rows, by key.

chosen: Option<Vec<ResourceId>>

The items selected, in the order they stand: the selection a host keeps for its person, given back so a list built again shows it as they left it.

scroll: Option<f64>

How far the list is scrolled, in logical pixels.

open: Option<ResourceId>

The item standing open into its document where it stands in the list: its row grows to hold what the item’s row gives as its detail, and Escape or a press beside it closes it. A host keeps which item is open and gives it back, so a list it builds again shows the item as the person left it.

motion: Option<Feel>

The pace its rows arrive, leave and change places at, and the rows it builds move at when they say nothing themselves: the theme’s unless it says otherwise.

select: Event

A row was selected: carries the item it shows.

activate: Event

A row was activated (a click, Enter, an assistive technology): carries the item it shows.

selected: Event

The selection changed: carries the items selected, in the order they stand, and none when the selection was put away.

opened: Event

The person opened a row into its item where it stands: carries the item.

closed: Event

The row standing open closed: pressed again, Escape, a press beside it, or its item left the list.

Trait Implementations

impl Component for VirtualListProps

const NAME: &'static str = "VirtualList"

The component’s name, as code calls it.

fn describe() -> Description

fn from_source(source: &mut dyn Source) -> Result<VirtualListProps, Error>

The props source gives.

impl Default for VirtualListProps

fn default() -> VirtualListProps

Returns the “default value” for a type.