Struct CarouselView 

pub struct CarouselView<State: 'static> { /* private fields */ }

A declarative M3E carousel. See the module docs.

Implementations

impl<State: 'static> CarouselView<State>

pub fn layout(self, layout: CarouselLayout) -> Self

Set the structural layout (type).

pub fn hero_alignment(self, alignment: HeroAlignment) -> Self

Where a CarouselLayout::Hero carousel’s focal item sits. Ignored by the other two layouts.

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

Show four descending items instead of three (isExtended). Applies to CarouselLayout::Contained only.

pub fn axis(self, axis: CarouselAxis) -> Self

Set the scroll axis (default CarouselAxis::Horizontal).

pub fn item_extent(self, extent: f64) -> Self

Main-axis extent of an CarouselLayout::Uncontained item, in logical px (default UNCONTAINED_ITEM_EXTENT). Capped at the viewport by the solver; ignored by the weighted layouts, which derive every extent from the viewport instead.

pub fn shrink_extent(self, extent: f64) -> Self

How small an item may shrink at the viewport edge before it slides off instead, in logical px (shrinkExtent). Defaults to 0.0 for the weighted layouts and UNCONTAINED_SHRINK_EXTENT for CarouselLayout::Uncontained, matching the reference’s own two defaults. Never exceeds the smallest slot.

pub fn item_radius(self, radius: f64) -> Self

Item corner radius, in logical px (childElementBorderRadius). Unset resolves shape.extra_large from the theme, then CAROUSEL_ITEM_RADIUS.

pub fn width(self, width: f64) -> Self

Pin the carousel’s own width, in logical px (M3ECarousel.width). Unset takes the incoming constraint.

pub fn height(self, height: f64) -> Self

Pin the carousel’s own height, in logical px (M3ECarousel.height). Unset takes the incoming constraint.

pub fn consume_max_weight(self, consume: bool) -> Self

Let the leading items expand into the largest slot (consumeMaxWeight), leaving a phantom gap before item 0 while they do.

Off by default, which is the choice upstream’s own top-level M3ECarousel makes: with it on, a theme rebuild can strand the extra leading extent offstage.

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

The focal item to start on (M3ECarouselController.initialItem). Only read on the first build; use selected to drive the carousel afterwards.

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

Drive the carousel from the app: it shows exactly this focal item and reports every requested index through on_change instead of moving itself (see the module docs).

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

Report the leading/focal item whenever either changes (onChange).

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

Report a tap on an item, by index (onTap).

Trait Implementations

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

type Element = CarouselWidget

The retained widget this view produces.

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

Materialise a fresh widget for this view.

fn rebuild( &self, prev: &Self, element: &mut CarouselWidget, 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.

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

Tear down element when this view is being removed.

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

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