Skip to content

Carousel

Carousel is a component that displays multiple items (images, content, etc.) in a slide format. It has an automatic slide feature.
Added in v4.0.0.

Property

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-generatedidstringAuto-generatedThe [id] property cannot be set by actions.
2WidthString300widthstring300Component width
3HeightString200heightstring200Component height
4XStringxstringX coordinate position
5YStringystringY coordinate position
6Icon ColorStringiconColorstringIcon color shown when no image is set
7Background ColorStringbackgroundColorstringBackground color shown when no image is set
8Object FitSelection
1. Cover
2. Contain
3. None
CoverobjectFitstringcoverImage display method
9Allow Slide NextBooleanONallowSlideNextbooleantrueEnables moving to the next slide
10Allow Slide PrevBooleanONallowSlidePrevbooleantrueEnables moving to the previous slide
11Allow Touch MoveBooleanONallowTouchMovebooleantrueTouch operation setting for slides
12Auto PlayObject{enabled: false, delay: 3000}autoPlayobject{enabled: false, delay: 3000}enabled: auto play setting
delay: interval between slides (milliseconds)
If this parameter is not set, auto play is disabled.
13EffectSelection
1. Slide
2. Fade
3. Cube
4. Coverflow
5. Flip
6. Cards
Slideeffect
1. slide
2. fade
3. cube
4. coverflow
5. flip
6. cards
stringslideEffect setting when slides change
1. Slide - Slides horizontally or vertically
2. Fade - Images fade between transitions
3. Cube - Images rotate like faces of a cube
4. Coverflow - The center slide is emphasized and adjacent slides are arranged with depth
5. Flip - Transitions by flipping like turning over a card
6. Cards - Cards overlap and the next card comes forward
14SpeedNumber300speednumber300Transition time between slides (milliseconds)
15Free ModeObject{enabled: false, momentum: true, sticky: false}freeModeobject{enabled: false, momentum: true, sticky: false}Free mode setting
enabled: enable free mode
momentum: enable momentum scrolling
sticky: stop at the nearest slide when scrolling ends
16LoopBooleanOFFloopbooleanfalseSlide loop setting
17DirectionSelection
1. Horizontal
2. Vertical
Horizontaldirection
1.horizontal
2.vertical
stringhorizontalSlide direction setting
18NavigationBooleanONnavigationbooleantrueShow/hide previous and next buttons
Button design cannot be changed.
19Slides Per ViewNumber1slidesPerViewnumber1Number of slides shown at the same time
20Slides Per GroupNumber1slidesPerGroupnumber1Number of slides to move per transition
21Space BetweenNumber0spaceBetweennumber0Spacing between slides (px)
22ThresholdNumber5thresholdnumber5Threshold for moving to the next slide during swipe operation
23PaginationObject{enabled: true, clickable: false, type: ‘bullets’}paginationobject{enabled: true, clickable: false, type: ‘bullets’}Pagination settings
enabled: enable pagination
clickable: enable pagination click
type: pagination type (bullets, fraction, progressbar)
24ScrollbarObject{enabled: true, hide: true}scrollbarobject{enabled: true, hide: true}Scrollbar settings
enabled: enable scrollbar
hide: show scrollbar only during user operation
25VisibilityBooleanONvisibilitybooleantrueComponent visibility
26ValueArray of Object[Detail 1]valuearray of object[Detail 1]Display image settings
27Initial SlideNumber0initialSlidenumber0First slide to display
The first slide configured in [Value] is 0.
28Click EventSelect
1. None
2. Action
NoneclickEventstringnoneEvent on click
29SelectedObject[Detail 2]selectedobject[Detail 2]Information of the clicked slide

[Detail 1] Value (value)

The default state is registered as follows. Register using the [ADD] button. To delete, select the [Select] checkbox and click the [DELETE] button.
There is no restriction on the strings that can be set.

SelectIDImageTitle BarTitleSubtitlePosition
Checkbox01/carousel/image_01.pngCheckbox: truebottom
Checkbox02/carousel/image_02.pngCheckbox: truebottom

value is an array of objects.

[
{
"id": "01",
"image": "/carousel/image_01.png",
"titleBar": true,
"title": "WebPerformer-NX Carousel Component",
"subTitle": "Carousel is a component that displays multiple items such as images and content in a slide format",
"position": "bottom"
}
]

[Detail 2] Selected Slide (selected)

selected is an object.

{
"id": "01",
"image": "/carousel/image_01.png",
"titleBar": true,
"title": "WebPerformer-NX Carousel Component",
"subTitle": "Carousel is a component that displays multiple items such as images and content in a slide format",
"position": "bottom"
}

Events

Event NameDescription
onclickExecutes an action when clicked.