Struct List 

pub struct List { /* private fields */ }

A list that renders only the rows its viewport holds.

Implementations

impl List

pub fn new( ident: impl Into<Ident>, count: usize, render_row: impl Fn(usize, &mut Window, &mut App) -> ListItem + 'static, ) -> Self

pub fn selected(self, id: impl Into<SharedString>) -> Self

pub fn row_height(self, height: f32) -> Self

Every row is this tall. Uniform height is what makes the list cheap; the default comes from the control scale for the list’s size.

pub fn visible_rows(self, rows: usize) -> Self

Bounds the viewport to rows rows, which is what lets the list skip the rows it does not show.

pub fn on_select( self, handler: impl Fn(SharedString, &mut Window, &mut App) + 'static, ) -> Self

pub fn reorderable(self, reorderable: bool) -> Self

Lets a row be picked up and put down somewhere else in the list.

The whole row is the handle. A list row’s ordinary action is a click, and GPUI only calls a press a drag once it has travelled two pixels, so both fit on the same row without a grip column the caller would have to render into every row it owns.

pub fn accepts( self, predicate: impl Fn(&DragItem, &DropPosition) -> bool + 'static, ) -> Self

Whether this list takes a payload, and where.

Without one, a reorderable list takes its own rows and nothing else. Anything wider than that is policy, and policy is the caller’s.

pub fn on_reorder( self, handler: impl Fn(&DropIntent, &mut Window, &mut App) + 'static, ) -> Self

Reports where a dropped row should go. The list does not move it.

Trait Implementations

impl Debug for List

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Disableable for List

fn disabled(self, disabled: bool) -> Self

impl IntoElement for List

type Element = ViewElement<List>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for List

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.

impl Sizable for List

fn control_size(self, size: ControlSize) -> Self

fn xs(self) -> Self

fn small(self) -> Self

fn medium(self) -> Self

fn large(self) -> Self