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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

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).

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Basic keyboard-navigable carousel

html