CarouselComponent

Represents the VueJS Carousel Component.

<ejs-carousel :items='carouselItems'></ejs-carousel>

Properties

allowKeyboardInteraction

boolean

Defines whether to allow keyboard interaction.

Defaults to true

animation

CarouselAnimationSettingsModel

Specifies the datasource for the carousel items.

Defaults to { effect: ‘Slide’, customEffect: null }

arrowsTemplate

string

Accepts the template for navigation arrows.

Defaults to null

autoPlay

boolean

Defines whether to the slide transition is automatic or manual.

Defaults to true

cssClass

string

Specifies the classes to customize carousel.

Defaults to null

dataSource

Record[]

Specifies the datasource for the carousel items.

Defaults to []

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableTouchSwipe

boolean

Defines whether to enable swipe action on touch devices.

Defaults to true

height

string | number

Specifies the height of the Carousel in pixels/number/percentage. Number value is considered as pixels.

Defaults to ‘auto’

htmlAttributes

Record

Defines htmlAttributes used to add custom attributes to carousel. Supports HTML attributes such as style, class, etc.

Defaults to null

indicatorsTemplate

string

Accepts the template for indicators.

Defaults to null

infinite

boolean

Defines whether to the slide transitions loop end or not.

Defaults to true

interval

number

Specifies the value for slide transition.

Defaults to 5000

itemTemplate

string

Specifies the template option for carousel items.

Defaults to null

items

CarouselItemModel[]

An array of item that is used to specify carousel items.

Defaults to []

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

playButtonTemplate

string

Accepts the template for play/pause button.

Defaults to null

selectedIndex

number

Specifies index of the current carousel item.

Defaults to 0

showArrows

string

Defines how to show the previous and next arrows.

Defaults to ‘Static’

showIndicators

boolean

Defines whether to show indicators.

Defaults to true

showPlayButton

boolean

Defines whether to show play button.

Defaults to false

width

string | number

Specifies the width of the Carousel in pixels/number/percentage. Number value is considered as pixels.

Defaults to ‘100%’

Methods

destroy

Method for destroy the carousel component.

Returns void

next

Method to transit from the current slide to the next slide.

Returns void

pause

Method to pause the slides programmatically.

Returns void

play

Method to play the slides programmatically.

Returns void

prev

Method to transit from the current slide to the previous slide.

Returns void

Events

slideChanged

EmitType<SlideChangedEventArgs>

The event will be fired once slide is changed.

slideChanging

EmitType<SlideChangingEventArgs>

The event will be fired before the slide change.