ICarouselProps

interface
Carousel

Props for OrigamCarousel — extends IWindowProps (slide management), IColorProps, IBgColorProps, IDimensionProps, IHoverProps, IActiveProps, ICommonsComponentProps and ITagProps, with carousel-specific controls for auto-cycle, delimiter icons and progress bar.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

cycle
boolean
Automatically advance slides on a timer.
delimiterIcon
TIcon
Icon rendered for each slide delimiter dot.
hideDelimiters
boolean
Hide the slide position delimiter dots.
hideDelimiterBackground
boolean
Remove the translucent background behind the delimiter dots.
interval
number | string
Auto-cycle interval in milliseconds. Only effective when cycle is true. Default 6000.
progress
boolean
Show a thin linear progress bar below the carousel that tracks cycle countdown.
verticalDelimiters
boolean | TInline
Render delimiter dots on the left or right side instead of at the bottom.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Auto-cycling carousel with progress bar

vue