Appearance
OrigamCarousel
<OrigamCarousel> is a sliding content area. Wrap <OrigamCarouselItem> children inside it. Navigation is controlled by delimiter dots, directional arrows, or programmatically.
Basic usage
vue
<template>
<OrigamCarousel>
<OrigamCarouselItem v-for="i in 4" :key="i">
<div class="slide">Slide {{ i }}</div>
</OrigamCarouselItem>
</OrigamCarousel>
</template>Auto-play
vue
<template>
<OrigamCarousel cycle :interval="3000">
<OrigamCarouselItem v-for="i in 4" :key="i">...</OrigamCarouselItem>
</OrigamCarousel>
</template>| Prop | Type | Default | Description |
|---|---|---|---|
cycle | boolean | false | Auto-advance slides |
interval | number | string | 6000 | Auto-play interval in milliseconds |
Delimiters
vue
<template>
<OrigamCarousel hide-delimiters hide-delimiter-background vertical-delimiters="left">
...
</OrigamCarousel>
</template>| Prop | Type | Default | Description |
|---|---|---|---|
delimiterIcon | TIcon | MDI_ICONS.CIRCLE | Icon for each delimiter button |
hideDelimiters | boolean | false | Hide the delimiter dots |
hideDelimiterBackground | boolean | false | Remove the semi-transparent bg behind delimiters |
verticalDelimiters | boolean | TInline | false | Place delimiters on the side ('left' or 'right') |
Progress bar
vue
<template>
<OrigamCarousel progress>
<OrigamCarouselItem v-for="i in 4" :key="i">...</OrigamCarouselItem>
</OrigamCarousel>
</template>| Prop | Type | Default | Description |
|---|---|---|---|
progress | boolean | false | Show a progress bar at the bottom |
Dimension
| Prop | Type | Default | Description |
|---|---|---|---|
height | string | number | 500 | Height of the carousel |
Arrows
| Prop | Type | Default | Description |
|---|---|---|---|
showArrows | boolean | 'hover' | true | Show navigation arrows |
continuous | boolean | true | Loop back from last to first slide |
Slots
| Slot | Bindings | Description |
|---|---|---|
default | window group | Carousel items (<OrigamCarouselItem>) |
additional | window group | Content overlaid after items (delimiters, progress) |
item | { props, item, index } | Custom delimiter button |
item.{n} | { props, item } | Custom delimiter for index n |
progress | { percent } | Custom progress bar |
play-pause | { isPaused, toggle, label } | Replaces the autoplay pause/play control (only rendered when cycle is on) |
prev | { props, canMove } | Custom previous arrow |
next | { props, canMove } | Custom next arrow |
arrows | { canMoveBack, canMoveForward, nextProps, prevProps } | Full arrows override |
Accessibility
<OrigamCarousel> renders the WAI-ARIA carousel pattern across two levels.
⛔ Pass an aria-label. Since #781 the root — inherited from <OrigamWindow> — carries role="region" + aria-roledescription="carousel"only when the carousel has an accessible name. region is one of the roles whose WAI-ARIA 1.2 definition marks the name as required, so an unnamed one is not a landmark anyone can navigate to; the DS declares nothing rather than declare a role it cannot name, and warns in development. The aria-label falls through automatically:
vue
<OrigamCarousel aria-label="Product gallery">…</OrigamCarousel>The visually-hidden role="status" live region announcing the current slide is unconditional. Each <OrigamCarouselItem> carries role="group" and aria-roledescription="slide" — unconditionally too: unlike region, group does not require an accessible name, so the slide boundary is kept whether or not the item is named.
Autoplay and WCAG 2.2.2
cycle starts the slideshow on its own and the default interval is 6 s, so WCAG 2.2.2 Pause, Stop, Hide (level A) requires a mechanism to stop it. Whenever cycle is on, the carousel therefore renders a pause/play <button> (aria-pressed reflects the paused state, and its aria-label is translated through origam.carousel.pause / origam.carousel.play).
prefers-reduced-motion: reduce is also honoured — the timer never arms — but that only covers users who set that system preference, so it does not satisfy the criterion on its own.
WARNING
Overriding the play-pause slot removes the built-in control. The replacement must still offer a way to stop the animation, or the component falls out of conformance. The slot hands you toggle and isPaused for exactly that purpose.
Emits
| Event | Payload | Description |
|---|---|---|
update:modelValue | unknown | Active slide identifier changed |
Design tokens
| Token | Description |
|---|---|
--origam-carousel---overflow | Overflow rule |
--origam-carousel__controls---height | Height of the delimiter strip |
--origam-carousel__controls---background-color | Background of delimiter strip |
--origam-carousel__controls-item---opacity | Inactive delimiter opacity |
--origam-carousel__controls-item---opacity-active | Active delimiter opacity |
--origam-carousel__progress---position-bottom | Bottom offset for the progress bar |