Struct MaterialCarousel 

pub struct MaterialCarousel { /* private fields */ }

An M3 carousel. label names it for assistive technology.

Implementations

impl MaterialCarousel

pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self

pub fn gap(self, gap: f32) -> Self

The space between items, in dp (the kit’s 8dp by default).

pub fn padding(self, padding: f32) -> Self

The leading and trailing padding, in dp (the kit’s 16dp by default).

pub fn corner_radius(self, radius: Pixels) -> Self

Item corners (the kit’s 28dp extra-large shape by default).

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

Whether resting scroll settles on an item boundary (on by default).

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

The current item: the leading focal one (the hero, centered). A new value scrolls there on the default spatial curve.

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

Called with the new current item when scrolling, dragging or the keyboard moves the carousel to another one.

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

pub fn items(self, items: impl IntoIterator<Item = CarouselItem>) -> Self

pub fn large_item_width(self, width: f32) -> Self

The large item’s width in dp (multi-browse and uncontained).

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

The item height in dp.

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

A fixed carousel width in dp; otherwise it fills its parent and uses the width measured in the previous frame.

Trait Implementations

impl IntoElement for MaterialCarousel

type Element = ViewElement<MaterialCarousel>

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 MaterialCarousel

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.