CarouselVariant

sealed class CarouselVariant(source)

CarouselVariant enum class which defines the variant of the Carousel component.

Variants:

  • SlideShow: Display a 1:1 aspect ratio Carousel which shows a single item at a time.

  • Theatre: Full screen Carousel in which the item can take up majority of screen space.

  • Overflow: Provides gives users a useful hint that there's more content for them to see.

  • OverflowWithoutIndicator: Behaves the same as Overflow. This variant does NOT display the indicator bar.

Inheritors

Types

Link copied to clipboard
sealed class Overflow : CarouselVariant

Use overflow variant when no need to display single items, overflow provides gives users a useful hint that there's more content for them to see.

Link copied to clipboard

Use Slideshow variant to display a 1:1 aspect ratio Carousel which shows a single item at a time. Possible use-case is a product details page.

Link copied to clipboard
data object Theatre : CarouselVariant

Use Theatre variant to display a full screen Carousel in which the item can take up majority of screen space. Possible use-case is when a Slideshow item has been clicked, opening a new modal containing a Theatre.