Skip to main content

Carousel Rail

Carousel Rail is a widget that scrolls through a horizontal row of items, such as featured projects or related articles.

Import

import { CarouselRail } from '@vortexlabs/vortex';
import type { CarouselRailProps } from '@vortexlabs/vortex';

Allied components

Other links

CarouselRail

CarouselRail props
PropTypeDefaultAttributes
children
React.ReactNode
No default value
onChange
callback
No default value
ariaLabel
string
No default value
swipeDisabled
boolean
No default value
itemsPerView
number
No default value
itemsPerScroll
union
auto
align
union
start
lazyMount
boolean
false
renderStatusText
callback
No default value
className
union
No default value
attributes
object
No default value
value
string
No default value
defaultValue
string
No default value
autoPlay
boolean
false
autoPlayInterval
number
5000
playLabel
string
Start slideshow
pauseLabel
string
Pause slideshow

CarouselRail.Viewport

CarouselRail.Viewport props
PropTypeDefaultAttributes
children
React.ReactNode
No default value
gap
number
4
borderRadius
union
No default value
className
union
No default value
attributes
object
No default value

CarouselRail.Item

CarouselRail.Item props
PropTypeDefaultAttributes
value
string
No default value
width
union
No default value
children
React.ReactNode
No default value
placeholder
React.ReactNode
No default value
className
union
No default value
attributes
object
No default value

CarouselRail.Controls

CarouselRail.Controls props
PropTypeDefaultAttributes
position
union
external
arrows
union
visible
variant
union
secondary
size
union
md
rounded
boolean
false
previousIcon
IconProps["src"]
ChevronLeft
nextIcon
IconProps["src"]
ChevronRight
previousAriaLabel
string
No default value
nextAriaLabel
string
No default value
className
union
No default value
attributes
object
No default value