Skip to main content

ListItem

Struct ListItem 

Source
pub struct ListItem<State: 'static> { /* private fields */ }
Expand description

A declarative M3 list row. See the module docs.

Implementations§

Source§

impl<State: 'static> ListItem<State>

Source

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

Add supporting text below the headline, promoting the row’s height per the reference’s line rule (see the module docs’ Height table).

Source

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

Add an overline label above the headline (M3EListItem.overline), promoting the row’s height per the reference’s line rule (see the module docs’ Height table).

Source

pub fn three_line(self) -> Self

Force the three-line (88dp) variant (for a supporting line that wraps to two visual lines).

Source

pub fn leading<V: View<State>>(self, leading: V) -> Self

Set the leading slot (an icon/avatar/image/control) — vertically centered, or pinned to the top inset on a three-line row.

Source

pub fn trailing<V: View<State>>(self, trailing: V) -> Self

Set the trailing slot (an icon, a metadata/supporting-text run, a checkbox/switch) — vertically centered, or pinned to the top inset on a three-line row.

Source

pub fn on_press<F: Fn(&mut State) + 'static>(self, on_press: F) -> Self

Make the whole row interactive, firing on_press on release inside its bounds (see the module docs’ Interactivity section).

Source

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

Paint the row’s container with the selected fill (colors.secondary_container, M3EListItemTheme.selectedColor) and report the state to accessibility. Defaults to false. A selected row paints its fill whether or not it is ListItem::contained — the state has to be visible.

Source

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

Paint the reference’s standalone row surface: the filled-card container (colors.surface_container_highest) at the shape.medium radius. Defaults to false — a bare row is content, the shape a row hosted by super::card_list (or any other container that owns the surface) needs. See the module docs’ Container surface section for why this port inverts the reference’s default.

Source

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

Gate the interactive treatment (hover/press tint and firing ListItem::on_press) and dim the container, without dropping back to a transparently-forwarding row. Defaults to true; only meaningful once on_press is chained. See the module docs’ Disabled state section.

Trait Implementations§

Source§

impl<State: 'static> View<State> for ListItem<State>

Source§

type Element = ListItemWidget

The retained widget this view produces.
Source§

fn build(&self, ctx: &mut BuildCtx<'_>) -> ListItemWidget

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &Self, element: &mut ListItemWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags

Reconcile prev (the previous view of the same type) against the live element, mutating it in place and reporting what changed.
Source§

fn teardown(&self, element: &mut ListItemWidget, ctx: &mut BuildCtx<'_>)

Tear down element when this view is being removed. Read more
Source§

fn message(&self, _element: &mut Self::Element, _state: &mut State)

Deliver an event message to this view, mutating application state. Read more

Auto Trait Implementations§

§

impl<State> !RefUnwindSafe for ListItem<State>

§

impl<State> !Send for ListItem<State>

§

impl<State> !Sync for ListItem<State>

§

impl<State> !UnwindSafe for ListItem<State>

§

impl<State> Freeze for ListItem<State>
where Option<AnyView<State>>: Freeze, Option<Rc<dyn Fn(&mut State)>>: Freeze,

§

impl<State> Unpin for ListItem<State>
where Option<AnyView<State>>: Unpin, Option<Rc<dyn Fn(&mut State)>>: Unpin,

§

impl<State> UnsafeUnpin for ListItem<State>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<State, V> ViewSeq<State, One> for V
where State: 'static, V: View<State>,

Source§

fn extend_views(self, out: &mut Vec<AnyView<State>>)

Push every element of this sequence, in order, onto out — erasing each with AnyView::new (a no-op for an element already an AnyView).
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more