IWindowProps

interface
Layout & Structure

Props contract for <OrigamWindow> — a swipeable, keyboard-navigable carousel container. Combines visual theming, directional control, navigation arrows, touch handling and group selection.

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.

continuous
boolean
When true, navigating past the last item wraps back to the first (and vice-versa).
nextIcon
TIcon
Icon rendered on the "next" navigation arrow button.
prevIcon
TIcon
Icon rendered on the "previous" navigation arrow button.
reverse
boolean
Reverses the slide transition direction so next slides in from the left.
showArrows
string | boolean
Controls visibility of prev/next arrow buttons. Pass true to always show, false to hide, or "hover" to show only on pointer hover.
touch
boolean | ITouchHandlers
Enable touch/swipe navigation. Pass false to disable, or an ITouchHandlers object to customise swipe callbacks.
modelValue
any
Index or value of the currently visible slide (v-model).
disabled
boolean
Disables all navigation interactions (arrows, touch, keyboard).
selectedClass
string
CSS class added to the currently active WindowItem.
mandatory
boolean
When true, at least one item must always be selected (prevents deselection).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Basic keyboard-navigable carousel

html