CarouselItem

Data Display
stable

A single slide inside OrigamCarousel — wraps OrigamWindowItem and OrigamImg, forwarding all image and window-item props.

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

Anatomy of OrigamCarouselItemSchematic of the CarouselItem component with 3 numbered internal parts. origam-img (src, cover, srcset, alt…) #content slot (overlay) 1 2 3 ① root = origam-window-item; height: inherit flows from the parent Carousel
Anatomy of <origam-carousel-item> — 3 internal parts. The root delegates to OrigamWindowItem; the image fills the inherited height.
1.origam-carousel-item
Root element. Delegates to OrigamWindowItem and inherits height from the parent Carousel.
2origam-img (embedded)
OrigamImg instance filling the slide area. Props (src, cover, alt, srcset, eager…) are forwarded automatically. Skipped when the default slot is used.
3#content slot
Projected into OrigamImg's default slot. Use for overlay captions, badges, or action buttons positioned over the image.

API

Props

All props accepted by this component, with their type, default value and description.

transition
boolean | string
Slide-in transition name or false to disable. Forwarded to OrigamWindowItem.
alt
string
Alt text for the embedded image. Required for accessibility when src is set.
cover
boolean
false
Passes object-fit: cover to OrigamImg so the image fills the slide without distortion.
draggable
boolean
gradient
string
lazySrc
string
options
IIntersectionObserverInit
sizes
string
src
string | ISrcObject
Image URL. Forwarded to OrigamImg. When omitted, the default slot fills the slide area.
crossorigin
TCrossOrigin
referrerpolicy
TReferrerPolicy
srcset
string
Responsive image srcset. Forwarded to OrigamImg.
position
string
color
TColor
bgColor
TColor
aspectRatio
string | number
contentClass
string
height
number | string
maxHeight
number | string
maxWidth
number | string
minHeight
number | string
minWidth
number | string
width
number | string
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
Inline styles forwarded to the root OrigamWindowItem element.
tag
string
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
borderTop
boolean | number | string
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderColor
string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
rounded
boolean | number | string | TRounded | null | undefined
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
eager
boolean
false
Loads the image immediately instead of using IntersectionObserver lazy loading.
reverseTransition
boolean | string
Reverse (slide-out) transition. Forwarded to OrigamWindowItem.
value
any
Model value used by OrigamWindow to identify the active slide.
disabled
boolean
false
Prevents this slide from being selected.
selectedClass
string

API

Slots

Content slots exposed by this component.

#default
Full slide content. When used, the embedded OrigamImg is replaced entirely by this slot.
#content
Projected into the OrigamImg default slot — renders on top of the image (overlay text, badges, etc.).
#error
Shown inside OrigamImg when the image fails to load.
#placeholder
Shown inside OrigamImg while the image is still loading.

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to a child component (OrigamImg or OrigamWindowItem).
Ref<string>
Reactive CSS string generated by useStyle for the carousel item.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet into the document.
() => void
Removes the injected style sheet.
Ref<boolean>
True once the style sheet has been injected into the DOM.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

Display mode of the root element.
Height inherited from the parent Carousel container.

Inclusion

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

Keyboard interactions

Keyboard interactions
KeyAction
TabFocus moves to interactive content inside the slide (links, buttons, form elements).

Notes

  • When src is set, always provide a meaningful alt attribute. An empty alt="" is acceptable for purely decorative images.
  • Inactive slides are hidden from the accessibility tree by OrigamWindowItem (aria-hidden="true") — only the active slide is reachable by keyboard and screen readers.

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Basic slide with image

vue

Custom slide content

vue

Loading placeholder

vue

Ecosystem

Family

Components from the same folder that share conventions and often compose together.